使用DocFX命令行生成文檔

使用docfx 命令

1.下載

https://github.com/dotnet/docfx/releases

2.使用

創(chuàng)建初始項目

docfx init -q

此命令生成一個名為docfx_project的默認項目。

3.生成網(wǎng)站

docfx docfx_project\docfx.json --serve

現(xiàn)在你可以訪問http://localhost:8080查看生成的網(wǎng)站。使用 -p 端口 可以指定端口。

?

API文檔

將編寫的項目復制到docfx_project\src 文件夾，然后生成即可。

默認為搜索項目，也可設置為解決方案，打開docfx.json 文件

"metadata": [{"src": [{"files": ["src/**/*.sln"],"exclude": ["**/obj/**","**/bin/**","_site/**"]}],

"src/**/*.sln" 為遍歷src 下的子文件夾里的sln文件。

REST API文檔

DocFX現(xiàn)在支持Swagger規(guī)范版本2.0之后生成的REST API文檔。

Swagger RESTful API文件必須以.json 結尾的文件。

一個Swagger API文件生成一個HTML文件。例如。文件contacts.swagger.json生成文件命名contacts.html。

在docfx_project?新建一個restapi文件夾，然后將json 文件復制進去，再新建一個toc.md?

# [API](api.json)

接著在docfx_project 文件夾下toc.yml 加一行

- name: REST APIhref: restapi/

再在docfx.json 文件中

"build": {"content": [{"files": ["api/**.yml","api/index.md"]},{"files": ["articles/**.md","articles/**/toc.yml","toc.yml","*.md","restapi/**"],"exclude": ["obj/**","_site/**"]}],

加入?"restapi/**" ，重新生成訪問就可以看到REST API。

最終效果圖如下：

?

?

文檔：https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html

示例項目：https://github.com/docascode/docfx-seed

?

總結

以上是生活随笔為你收集整理的使用DocFX生成文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內容還不錯，歡迎將生活随笔推薦給好友。