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

無論是團隊開發(fā)還是個人開發(fā) ，一個漂亮的技術文檔是至關重要的 。

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

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

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

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