docsify

38次阅读

共计 346 个字符,预计需要花费 1 分钟才能阅读完成。

在开发项目时,想要将 md 文档统一管理,docsify 是不错的选择。无需构建和编译, 写完 markdown 就可以直接发布。
快速上手
全局安装 docsify-cli 工具
npm i docsify-cli -g
初始化项目
docsify init ./docs
初始文件 index.html 入口文件 README.md 会做为主页内容渲染 .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
然后直接用浏览器打开 localhost:3000,就可以看到基本的网页框架了。就像酱紫。

特性

容易使用并且轻量 (~18kB gzipped)
智能的全文搜索
提供多套主题
丰富的 API
支持 Emoji
兼容 IE10+
支持 SSR (example)

如果觉得 README.md 主页面太简陋的话可以自己写。链接文档改成对应的 url。

正文完
 0