一直在用 docsify 做为轻量级文档工具来使用,非常好用,这里推荐一下。
文档痛点
说到写文档,不得不说几个写文档的痛点:
- 支持 markdown
- 支持代码高亮
- 排版及样式好
- 易于分享及部署
简单点说就是,我只想安安静静的写个 markdown 文档,别整一些花里胡哨的东西。
为什么是 docsify
首先它完美解决了以上痛点,另外还有额外的特性
- 无需构建,写完文档直接发布
- 容易使用并且轻量 (~19kB gzipped)
- 智能的全文搜索
- 提供多套主题
- 丰富的 API
- 支持 Emoji
- 兼容 IE10+
以上都是花里胡哨的亮点,但是我并不关心,毕竟我只需要核心功能。
说说最大亮点:无需要构建,写完文档直接发布
想想,如果你写完一个 markdown 文件,git 提交部署到服务器上,然后别人在浏览器上直接刷新就可以看到你提交的文档,是不是很爽?更爽的是这个过程完全只需要一个静态服务就可以,完全不需要其它的东西。
快速开始
这里我个人提供了一个快速开始的模版:https://github.com/leo-yi/doc_template
使用方法非常简单,仅需要安装 docsify 然后一条命令驱动即可。
npm i docsify-cli -g
git clone [email protected]:leo-yi/doc_template.git
docsify serv doc_template/
tip: 配置使用的是默认配置。如果需要更多高级配置,请参考官方文档。
最后希望写文档将不再难 ?