docsify
文章目录
在开发项目时,想要将md文档统一管理,docsify是不错的选择。无需构建和编译,写完markdown就可以直接发布。
快速上手
全局安装docsify-cli工具
npm i docsify-cli -g
初始化项目
docsify init ./docs
初始文件
index.html 入口文件
README.md 会做为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
启动项目
docsify serve docs
然后直接用浏览器打开localhost:3000,就可以看到基本的网页框架了。就像酱紫。
| 特性 |
|---|
| 容易使用并且轻量 (~18kB gzipped) |
| 智能的全文搜索 |
| 提供多套主题 |
| 丰富的 API |
| 支持 Emoji |
| 兼容 IE10+ |
| 支持 SSR (example) |
如果觉得README.md主页面太简陋的话可以自己写。链接文档改成对应的url。
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论