官网:https://docsify.js.org/#/
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。
一、初始化项目
1.1 安装Node.js
下载地址:https://nodejs.org/dist/v8.9.4/node-v8.9.4-x64.msi
下载完成后点击安装。
查看node 版本,命令:node -v
版本:v8.9.4
1.2 安装docsify-cli工具
命令行执行:
npm i docsify-cli -g
复制代码
会在这个路径下
C:\Users\Administrator\AppData\Roaming\npm\node_modules
生成 docsify-cli 文件夹
1.3 初始化文档结构
先创建一个本地文件夹docs,然后执行命令
docsify init ./docs
复制代码
会生成如下目录:
-| docs/
-| .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
-| index.html 入口文件
-| README.md 会做为主页内容渲染复制代码
直接编辑 docs/README.md 就能更新网站内容
遇到的问题:
初始化docsify文档不成功
升级node.js之后就成功了