1. 前言

昨天忙里偷闲分享了一个关于微信支付的开发包Payment Spring Boot，有同学问文档是用什么搞的，今天就来分享一下关于程序员写项目文档的工具。无论是工作内部记录，还是开源分享都非常有用。

2. MarkDown

MarkDown具有非常简单的语法来进行文字、代码块、数学公式的排版，甚至还是实现流程图、思维导图。具有简单快捷的特点。

下面是原生的MarkDown:

下面是预览后的MarkDown:

配合MarkDown的快捷键，基本随手就可以编排出漂亮的文档。胖哥写了几百篇公众号都是用Markdown写的。无论是新手还是老手，MarkDown都是要掌握的。

另外这里推荐一款很好用的MarkDown编辑器 Typora ，真的很好用，谁用谁知道。

3. Docsify

Docsify 可以快速帮你生成文档网站。它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。它提供了中文文档：https://docsify.js.org/#/zh-cn/

如果你会MarkDown，半个小时你就能搭建一个属于你自己的文档网站，它相当简单好用。就在我写这篇文章的时候Docsify刚刚获得了2020年开源中国的最佳人气的开源项目。

4. Hexo

Docsify用来搭建文档是非常轻便的，但是它并不适用搭建个人博客。正如上面所言，它不会生成静态页面，因此不方便进行SEO等等更多的操作。在搭建个人博客的选择上Hexo具有更佳的表现，它被开发出来的初衷就是搭建博客系统，它具有很多的样式可供选择，同时提供了插件市场你可以定制自己的博客风格和功能。最关键的是它也提供了中文文档 ，你可以去学习配置。我的个人博客就是用Hexo自己改的。

VuePress搭建博客也是非常出色的，你也可以去试试Vue风格的。

5. 总结

不要小看文档，如果你能把自己开发的思路通过文档清晰的表达出来，也是一个突出亮点。很多大牛都有很强的背书能力，所以写作、画图都是不可或缺的能力。希望今天的分享对你有用。我是 码农小胖哥