[[357952]]

1. 前言

昨天忙里偷閑分享了一個(gè)關(guān)于微信支付的開(kāi)發(fā)包 Payment Spring Boot，有同學(xué)問(wèn)文檔是用什么搞的，今天就來(lái)分享一下關(guān)于程序員寫項(xiàng)目文檔的工具。無(wú)論是工作內(nèi)部記錄，還是開(kāi)源分享都非常有用。

2. MarkDown

MarkDown可以通過(guò)非常簡(jiǎn)單的語(yǔ)法來(lái)進(jìn)行文字、代碼塊、數(shù)學(xué)公式的排版，甚至還是實(shí)現(xiàn)流程圖、思維導(dǎo)圖。具有簡(jiǎn)單易學(xué)、快捷方便的特點(diǎn)。

下面是原生的 MarkDown:

MarkDown 的源碼

下面對(duì)應(yīng)的是預(yù)覽后的 MarkDown:

渲染后的MarkDown

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

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

3. Docsify

Docsify 可以快速幫你生成文檔網(wǎng)站。它不會(huì)生成靜態(tài)的 .html 文件，所有轉(zhuǎn)換工作都是在運(yùn)行時(shí)。如果你想要開(kāi)始使用它，只需要?jiǎng)?chuàng)建一個(gè) index.html 就可以開(kāi)始編寫文檔并直接部署在 GitHub Pages 或者Gitee Pages。它提供了中文文檔：https://docsify.js.org/#/zh-cn/

如果你會(huì)MarkDown，半個(gè)小時(shí)你就能搭建一個(gè)屬于你自己的文檔網(wǎng)站，它相當(dāng)簡(jiǎn)單好用。就在我寫這篇文章的時(shí)候Docsify剛剛獲得了 2020 年開(kāi)源中國(guó)的最佳人氣的開(kāi)源項(xiàng)目。

4. Hexo

Docsify用來(lái)搭建文檔是非常輕便的，但是它并不適用搭建個(gè)人博客。正如上面所言，它不會(huì)生成靜態(tài)頁(yè)面，因此不方便進(jìn)行 SEO 等等更多的操作。在搭建個(gè)人博客的選擇上Hexo具有更佳的表現(xiàn)，它被開(kāi)發(fā)出來(lái)的初衷就是搭建博客系統(tǒng)，它具有很多的樣式可供選擇，同時(shí)提供了插件市場(chǎng)你可以定制自己的博客風(fēng)格和功能。最關(guān)鍵的是它也提供了中文文檔 ：https://hexo.io/zh-cn/，你可以去學(xué)習(xí)配置。我的個(gè)人博客就是用Hexo自己改的：https://felord.cn

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

5. 總結(jié)

不要小看文檔，如果你能把自己開(kāi)發(fā)的思路通過(guò)文檔清晰的表達(dá)出來(lái)，也是一個(gè)突出亮點(diǎn)。很多大牛都有很強(qiáng)的背書能力，所以寫作、畫圖都是不可或缺的能力。

本文轉(zhuǎn)載自微信公眾號(hào)「碼農(nóng)小胖哥  」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系碼農(nóng)小胖哥公眾號(hào)。