docsify创建文档站点

doscify 介绍

docsify 是一个动态生成文档网站的工具。所有转换工作都是在运行时进行。如果只是需要快速搭建一个小型的文档网站，或者不想因为生成的一堆.html文件污染commit记录，只需要创建一个index.html就可以开始写文档而且直接部署在GitHub Pages。docsify介绍

使用 docsify-cli 创建项目

# 全局安装
npm i doceify-cli -g
# 查看看装是否成功
docsify -v

# 项目初始化
docsify init ./
# 初始化后生成如下几个文件
1. index.htm 入口文件 
2. README.md 主页内容渲染
3. .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件  

# 启动本地服务 (通过 http://localhost:300 访问)
docsify serve ./ 

文件和URL路径说明

例如创建一个guide.md文件，对应的路由就是/#/guide

./README.md				=> /
./guide.md				=> /#/guide
./zh-cn/README.md		=> /#/zh-cn/
./zh-cn/guide.md		=> /#/zh-cn/guide

设置侧边栏

1. 在index.html文件中配置

window.$docsify = {
    loadSidebar: true
}

2. 在项目根目录创建_sidebar.md文件

* [首页](/)
* [文档说明](/doce)

显示页面目录

1. 在index.html文件中进行设置

window.$docsify = {
    loadSidebar: true,
    subMaxLevel: 3 // 表示显示的目录层级
}

// 忽略特定的标题
// {docsify-ignore-all}  忽略所有
## Header {docsify-ignore}