-

docsify 简介

docsify 是文档类型网站搭建工具，可以即时生成您的文档网站。与 GitBook 不同，它不会生成静态html文件。相反，它可以智能地加载和解析您的M arkdown 文件并将其显示为网站。

参考教程

• 官方教程：https://docsify.js.org/#/zh-cn/quickstart
• 手把手教你搭建一个文档类型的网站!免费且高速！
• Docsify 进阶配置

使用说明

使用前准备

1. 下载安装 NPM 并且使用这个命令：npm i docsify-cli -g 安装了 docsify-cli 这个工具。下载成功后在npm所配置的文件目录

2. 确保有一个 Github 账号（码云账号为非必选项，有的话更好）

初始化项目并预览

创建一个文件夹，进入文件夹并运行 docsify 初始化命令

docsify init ./

当前文件目录生成三个文件

.nojekyll  ---> 用于阻止github pages 会忽略掉下划线开头的文件
index.html ---> 入口文件，也可以称为配置文件，相关配置都在此文件
README.md  ---> 会做为主页内容渲染

本地预览网站输入命令：docsify serve ./ 然后访问：http://localhost:3000/

相关配置

修改配置文件 index.html

主要配置了文档网站的名字以及开启了一些配置选项

添加侧边栏文件

在 index.html 文件中设置开启

window.$docsify = {
  ...
  loadSidebar: true, // 添加侧边栏文件
}

还需要定义一个名为 _sidebar.md 的文件，此文件的内容就是侧边栏的内容

PS. 一般建议将文档放进 docs 文件下面

上传到github或者gitee

需要开启动github page或者gitee pages服务