做一個像微軟一樣的文檔平臺，開源文檔工具 docfx

無論是團(tuán)隊(duì)開發(fā)還是個人開發(fā)，一個漂亮的技術(shù)文檔是至關(guān)重要的。

docfx 是微軟官方支持的一個 dotnet 平臺的 API 文檔生成工具，功能及其強(qiáng)大，自定義程度極高 ，微軟自己的 MSDN 構(gòu)建就用到了 docfx。目前 docfx 默認(rèn)官方支持 C#, VB and F# 語言，但在 github 上 ，基本上常見的語言都有 docfx 開源項(xiàng)目。

docfx 可以從代碼注釋中自動生成 api 文檔 ，如果需要的話，你還可以很方便地從 markdown 文件中生成技術(shù)教程。因此，docfx 用好了，它就不僅僅是API文檔生成器 ，還是一個簡單的博客網(wǎng)站構(gòu)建器。docfx 主要有以下特點(diǎn) ：

• 與 github 和 源代碼緊密結(jié)合 ，你可以直接在文檔中點(diǎn)擊查看源碼
• 開源跨平臺，支持 Windows 、Linux、macOS
• 這個是最強(qiáng)大的，與 Visual studio 無縫集成 ，項(xiàng)目完成時文檔平臺自動生成。
• 完善的 Markdown 支持，引入了與 更方便寫文檔 、且GFM 完全兼容的 DocFX Flavored Markdown(DFM)DFM ，可以實(shí)現(xiàn)文件引用 、代碼片段等功能

docfx 可以通過命令行方式獨(dú)立使用 ，但筆者更推薦通過 Visual studio 繼承使用
，這樣與你的開發(fā)流程結(jié)合更緊密 
。

通過 Visual studio 使用 docfx 非常簡單 、絲滑無比。只需在你的項(xiàng)目中引入 docfx.console nuget 庫，然后按照正常流程構(gòu)建項(xiàng)目，就會自動生成一個 _site 文件夾，里面包含已經(jīng)生成的文檔文件，完全不用你多做任何事情。你所需要做的就是好好寫代碼和注釋
，文檔的事情全部打包給 docfx!

當(dāng)然， docfx 強(qiáng)大的功能決定了要用好，你還是要下一番功夫的，因?yàn)榭勺远x的地方特別多。這就需要在使用中慢慢琢磨了，起碼官方和第三方提供的大量插件和模板 ，還是要花一些時間了解一下的 。

推薦指數(shù)：

項(xiàng)目地址:托管在 github ,搜索docfx 即可

投稿時間：2022-05-15  最后更新