文档编排¶
概述¶
俗话说：不会写文档的程序员都是在耍流氓
文档的用途有很多：
- 知识框架梳理
- 项目帮助文档
- 项目API文档
- 电子书
现有的编写文档方式有很多：
| 写作方式 | 标记语言 | 应用场景 |
|---|---|---|
| GitHub Wiki | Markdown | 知识框架梳理等 |
| Gitbook | Markdown | 知识框架梳理、电子书等 |
| Sphinx | reStructuredText / Markdown | 项目帮助文档、项目API文档、电子书等 |
当然，还有其它的方式，比如： CSDN博客 、博客园 、私有博客 等；但是博客有一致命弱点：编排杂乱，不便索引
该系列文章将围绕上述3种主流的文档编排方式进行展开说明。