docsify轻量级文档系统

root安装

推荐安装 docsify-cli 工具，可以方便创建及本地预览文档网站。

npm i docsify-cli -g

普通用户下初始化项目

如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。

docsify init ./docs

开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

index.html 入口文件
README.md 会做为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新网站内容，当然也可以写多个页面。

本地预览网站

运行一个本地服务器通过 docsify serve 可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://localhost:3000 。

docsify serve docs

如果需要启动其他端口，可以直接在后面增加-p 4000表示启动端口为4000

更多命令行工具用法，参考 docsify-cli 文档。

手动初始化

如果不喜欢 npm 或者觉得安装工具太麻烦，我们其实只需要直接创建一个 index.html 文件。

index.html

更多文档说明

请访问 docsify轻量级文档 的中文文档页面进行阅读。

附录

我的目录结构

.
├── README.md
├── _sidebar.md              -- 目录索引
├── assets
│   ├── docsify.min.js       -- 从官网拉取下来的js
│   ├── theme-custom.css     -- 自定义的样式
│   └── theme-simple.css     -- 从官网拉取下来主题样式，修改过的本地css
├── index.html               -- 入口页面
├── start.sh                 -- 启动脚本
└── documents          --存放markdown文档的目录

我的index.html文件