使用DocFX生成文档

2024-05-15 01:46:00

使用DocFX命令行生成文档

使用docfx 命令

1.下载

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

2.使用

创建初始项目

docfx init -q

此命令生成一个名为docfx_project的默认项目。

3.生成网站

docfx docfx_project\docfx.json --serve

现在你可以访问http://localhost:8080查看生成的网站。使用 -p 端口可以指定端口。

API文档

将编写的项目复制到docfx_project\src 文件夹，然后生成即可。

默认为搜索项目，也可设置为解决方案，打开docfx.json 文件

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

"src/**/*.sln" 为遍历src 下的子文件夹里的sln文件。

REST API文档

DocFX现在支持Swagger规范版本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生成文档相关推荐

使用DocFx生成文档网站并将其发布到GitHub Pages
目录介绍 DocFx安装 Visual Studio中的测试解决方案使用docfx init设置DocFx 手动设置DocFx docfx.json配置文件的剖析元数据部分构建部分 docs文 ...
Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
java前端目录_[Java教程]前端那点事儿——Tocify自动生成文档目录
[Java教程]前端那点事儿--Tocify自动生成文档目录 0 2016-06-29 22:00:07 今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目 ...
快速优雅的为React组件生成文档
在开发React组件时我们通常需要处理2个问题: 实例化这个组件以便调试为这个组件编写使用文档以便更好的让别人知道怎么使用这个组件最原始的方法莫过于开发时建一个页面用于调试,开发完后再为其手写文档 ...
linux c/c++ 代码使用 doxygen 自动生成文档
www.doxygen.org 的使用非常方便,下面分成2步介绍一下 1. 注释风格,需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的 C++的注释风格主要使用下面这种样式:即在注释 ...
docwizard c++程序文档自动生成工具_如何开发一个基于 TypeScript 的工具库并自动生成文档
为什么用 TypeScript? TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. Any ...
使用javadoc命令生成文档
可以使用命令 javadoc *.java 生成文档
配置WCF同时支持WSDL和REST，swaggerwcf生成文档
配置WCF同时支持WSDL和REST,SwaggerWCF生成文档 VS创建一个WCF工程,通过NuGet添加SwaggerWcf 创建完成后通过程序包管理控制台 pm>Install-Pac ...

最新文章

热门文章