拾光小阁

一、安装 docsify#

1
npm i docsify-cli -g      # 全局安装 docsify
2

3
docsify init ./docs       # 初始化并创建 ./docs 文件夹

安装成功后，./docs 目录下会出现如下文件：

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

此时你可以编辑 README.md 修改主页内容，也可以使用如下命令在本地 3000 端口启动实时预览：

1
docsify serve ./docs

二、多页文档#

直接在 docs 目录下新建 .md 文件，通过 域名/文件名 访问。

三、定制侧边栏#

多页文档创建后，默认只能手动输入地址访问。要实现侧边栏导航，需要如下操作：

1. 在 index.html 中找到 window.$docsify = {，添加 loadSidebar: true 配置：

   1
   <script>
   2
     window.$docsify = {
   3
       loadSidebar: true
   4
     }
   5
   </script>
   

2. 创建 sidebar.md 文件，用 Markdown 链接格式填写页面地址：

   1
   * 基础篇
   2
   * [前言](/)
   3
   * [硬件](1)
   4
   * [操作系统](2)
   5
   * [浏览器](3)
   

注：如上示例，1.md、2.md、3.md 分别对应“硬件”“操作系统”“浏览器”页面。

四、更多配置与插件#

更多配置项和插件说明请参考 官方文档。 所有配置均在 index.html 的 window.$docsify = {} 中设置。