做一个像微软一样的文档平台,开源文档工具 docfx
做一個(gè)像微軟一樣的文檔平臺(tái),開源文檔工具 docfx
無(wú)論是團(tuán)隊(duì)開發(fā)還是個(gè)人開發(fā),一個(gè)漂亮的技術(shù)文檔是至關(guān)重要的 。
docfx 是微軟官方支持的一個(gè) dotnet 平臺(tái)的 API 文檔生成工具 ,功能及其強(qiáng)大,自定義程度極高,微軟自己的 MSDN 構(gòu)建就用到了 docfx 。目前 docfx 默認(rèn)官方支持 C#, VB and F# 語(yǔ)言 ,但在 github 上 ,基本上常見的語(yǔ)言都有 docfx 開源項(xiàng)目。
docfx 可以從代碼注釋中自動(dòng)生成 api 文檔,如果需要的話 ,你還可以很方便地從 markdown 文件中生成技術(shù)教程 。因此 ,docfx 用好了,它就不僅僅是API文檔生成器,還是一個(gè)簡(jiǎn)單的博客網(wǎng)站構(gòu)建器 。docfx 主要有以下特點(diǎn):
- 與 github 和 源代碼緊密結(jié)合,你可以直接在文檔中點(diǎn)擊查看源碼
- 開源跨平臺(tái) ,支持 Windows