我已经设法为 DocFX 安装并进行了基本设置,但我在寻找某些问题的地方遇到了困难。
我想解决的第一个问题是我的 API 文档的 TOC,理想情况下按项目然后命名空间分解。
我可以在我的 API 文件夹的输出中看到带有 toc.yml 的预处理文件,如下所示:
### YamlMime:TableOfContent
- uid: Apollo.Shared.Sensitive
name: Apollo.Shared.Sensitive
items:
- uid: Apollo.Shared.Sensitive.BibliographicInformationRequest
name: BibliographicInformationRequest
- uid: Apollo.Shared.Sensitive.CheckLoginRequest
name: CheckLoginRequest
我的 dofx.json 如下:
{
"metadata": [
{
"src": [
{
"files": "**.csproj",
"exclude": [
"**/obj/**",
"**/bin/**"
],
"src": ".."
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"source/**"
],
"exclude": [
"obj/**",
"../../Documentation/**"
]
}
],
"dest": "../../Documentation",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": ["default", "templates/MyTemplate"],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}