程序员的文档利器 gitbook/mkdoc
这次我们介绍几个常用的程序员写文档、笔记和电子书的工具,gitbook/mkdocs/sphinx。 笔者以前用过一些印象笔记之类的软件,后来又回归了电子书工具。 一方面是可以用 github 托管和版本控制,同时完全基于文本(markdown/rst),可以用自己喜欢的编辑器来编辑文件。 而且还可以免费用 github pages 托管成一本电子书,方便自己和别人浏览。 作为程序员的你即使没有用过,也肯定见过这些工具编写过的文档。 比如很多知名的 Python 项目 Flask 等就是用 sphinx+readthedoc 构建的。
首先我们需要学习 markdown 或者 rst 等标记语言,网上很多教程直接看看就知道了。
视频里我会介绍下 mkdocs/sphinx 如何从零开始使用一个文档工具,编写自己的电子书并且用 github pages 托管访问。
- gitbook: 基于 nodejs,支持导出成 pdf/epub 等格式,使用 markdown 书写
- mkdocs: 基于Python,使用 markdown 书写
- sphinx: 基于 Python,可以用 rst/markdown 书写,很多知名 py 项目的选择。可以基于 docstring 生成文档,支持生成 pdf/epub 等,功能相比 gitbook/mkdocs 更加强大