[[357952]]

1. 前言

昨天忙里偷閑分享了一個關于微信支付的開發包 Payment Spring Boot，有同學問文檔是用什么搞的，今天就來分享一下關于程序員寫項目文檔的工具。無論是工作內部記錄，還是開源分享都非常有用。

2. MarkDown

MarkDown可以通過非常簡單的語法來進行文字、代碼塊、數學公式的排版，甚至還是實現流程圖、思維導圖。具有簡單易學、快捷方便的特點。

下面是原生的 MarkDown:

MarkDown 的源碼

下面對應的是預覽后的 MarkDown:

渲染后的MarkDown

配合 MarkDown 編輯器的快捷鍵，基本隨手就可以編排出漂亮的文檔。胖哥寫了幾百篇公眾號都是用Markdown寫的。無論是新手還是老手，MarkDown都是要掌握的。

另外這里推薦一款很好用的MarkDown編輯器 Typora ，真的很好用，配合圖床，誰用誰知道。

3. Docsify

Docsify 可以快速幫你生成文檔網站。它不會生成靜態的 .html 文件，所有轉換工作都是在運行時。如果你想要開始使用它，只需要創建一個 index.html 就可以開始編寫文檔并直接部署在 GitHub Pages 或者Gitee Pages。它提供了中文文檔：https://docsify.js.org/#/zh-cn/

如果你會MarkDown，半個小時你就能搭建一個屬于你自己的文檔網站，它相當簡單好用。就在我寫這篇文章的時候Docsify剛剛獲得了 2020 年開源中國的最佳人氣的開源項目。

4. Hexo

Docsify用來搭建文檔是非常輕便的，但是它并不適用搭建個人博客。正如上面所言，它不會生成靜態頁面，因此不方便進行 SEO 等等更多的操作。在搭建個人博客的選擇上Hexo具有更佳的表現，它被開發出來的初衷就是搭建博客系統，它具有很多的樣式可供選擇，同時提供了插件市場你可以定制自己的博客風格和功能。最關鍵的是它也提供了中文文檔 ：https://hexo.io/zh-cn/，你可以去學習配置。我的個人博客就是用Hexo自己改的：https://felord.cn

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

5. 總結

不要小看文檔，如果你能把自己開發的思路通過文檔清晰的表達出來，也是一個突出亮點。很多大牛都有很強的背書能力，所以寫作、畫圖都是不可或缺的能力。

本文轉載自微信公眾號「碼農小胖哥  」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。