docsify

优雅地制作笔记。

---

前言

在网上经常能看到像下面这样的文档，左边是目录，右边是内容。布局简洁，没有博客那样花里胡哨的，看起来十分舒服。这样的文档可以做Wiki，做API手册，做笔记

最初我是想着自己动手写一个，这种两栏布局实际上没多复杂，只是全写在html里不够优雅。于是我想到了 typora 可以把 Markdown 导出为 html，所以我只需要专注于笔记的内容，导出后用 JS 写个根据标题生成目录的函数就可以了。但这样还是麻烦了点，想看看现成的工具是不是能方便很多。

Gitbook 与 docsify

第一个想到的其实是 Gitbook，但是他已经好些年没维护了，折腾了一个小时的 node 版本，最终放弃。继而找到了 docsify。

docsify 的安装与使用

官网：https://docsify.js.org/#/zh-cn/themes

在有 nodeJS 的环境下，使用以下代码安装 docsify

npm i docsify-cli -g

在一个文件夹中初始化，

docsify init

成功后会在该文件夹下生成三个文件

• index.html 笔记唯一的 html 文件，入口

• README.md 笔记内容

• .nojekyll 防止 GitHub 页面忽略以下划线开头的文件

启动服务，打开 Listening at 后边的网址就可以正常访问了。

docsify serve
docsify s //跟 hexo 一样可以使用缩写

流程看着跟 hexo 很像，但他与那些静态博客不同的是，他只有一个 index.html，通过 JS 把 Markdown 文件的内容加载到html中。这不就是一个单页 app 吗？跟学 VUE 时的第一个 demo 像极了。这就是 docsify 的优点，不需要把 .html 转换成 .md，这样维护起来就舒服多了，部署的时候也只需要提交整个文件夹，不仅免去了生成文件的等待，Git 也能更好地记录历史版本。