IT工程師數位筆記本

微軟放棄Sandcastle有些年頭了,微軟最近開源了全新的文檔生成工具DocFX，目前支持C＃和VB，類似JSDoc或Sphinx，可以從源代碼中提取注釋生成文檔之外，而且還有語法支持你加入其他的文件鏈接到API添加額外的說明，DocFX會掃描你的源代碼和附加的文件為你生成一個完整的HTML模版網站，你可以自己通過模版定制，目前已經內嵌了幾個模版，包括靜態的HTML頁面和AngularJS頁面。你還可以自己定制模版，具體參考 how to create custom template。

源代碼： https://github.com/dotnet/docfx

文檔： http://dotnet.github.io/docfx/

• 點擊“查看源文件”的API來路由到GitHub的源代碼（您的API必須推送到GitHub上）
• 提供DNX版本跨平臺支持。
• Visual Studio的無縫內使用docfx。 注：官方docfx.msbuild的NuGet包現在在預發布版本。您也可以使用源代碼編譯，并在本地使用它。
• 我們支持Docfx Flavored Markdown(DFM) 編寫的文檔。  DFM是Github上 Markdown（GFM），并增加了一些新的功能，包括文件包含 ， 交叉引用 ，和YAML頭 100％兼容 。有關DFM詳細說明，請參考DFM

 
dotnet core網站就是使用docfx生成的文檔示例： dotnet core。

在docfx中，最重要的就是生成文檔，把markdown文件（gfm語法）轉換成html，微軟還開源一個基于gfm的并且很容易擴展的語法的markdown組件 MarkdownLite，代碼包含在docfx，nuget庫里包的名字是Microsoft.DocAsCode.MarkdownLite。

有一篇文檔詳細介紹了如何使用docfx： Getting Started with docfx，具體怎么使用請看這篇文章, 這里還有個OpenLiveWriter 的例子 Use docfx to auto-generate documents for OLW。

FAQ:

Q: docfx是什么？

A: docfx是一個api文檔編譯軟件，它能根據c#/vb源代碼生成對應的文檔元數據并生成文檔（目前提供html），并支持普通md文件。

Q: docfx的輸入和輸出是什么？

A: docfx metadata需要源代碼來生成文檔元數據，docfx build使用文檔元數據+普通md文件生成文檔（html）

Q: docfx支持定制模板么？

A: 是的，可以參考文檔

Q: docfx跨平臺么？

A: docfx支持在dnx下運行。