官网
address
快速的,运行编译,简洁,方便,易用的一款写文档工具,docsify。
安装
npm i docsify-cli -g
使用
- 创建目录并进入:
mkdir documents && cd documents
- 初始化项目:
docsify init ./docs
- 运行项目:
docsify serve docs
结构
初始化成功后,可以看到./docs
目录下创建的几个文件
- index.html 入口文件
- README.md 会做为主页内容渲染
- .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件