在开发项目时,想要将md文档统一管理,docsify是不错的选择。无需构建和编译,写完markdown就能够直接发布。html
全局安装docsify-cli工具npm
npm i docsify-cli -g
初始化项目浏览器
docsify init ./docs
初始文件
index.html 入口文件
README.md 会作为主页内容渲染
.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件markdown
启动项目
docsify serve docs
而后直接用浏览器打开localhost:3000,就能够看到基本的网页框架了。就像酱紫。框架
特性 |
---|
容易使用而且轻量 (~18kB gzipped) |
智能的全文搜索 |
提供多套主题 |
丰富的 API |
支持 Emoji |
兼容 IE10+ |
支持 SSR (example) |
若是以为README.md主页面太简陋的话能够本身写。连接文档改为对应的url。工具