yaml - 将生成的 TOC.yml 替换为自定义 TOC.yml
问题描述
我正在使用 docfx 为我的 .Net 项目生成 API 文档。我需要向不同类型的客户展示不同风格的内容。生成元数据时,也会生成 TOC.YML,这很好。但是,在生成 html 文件时,此 TOC 用于在每个 HTML 页面的侧面创建导航栏。问题是对于某些观众,完整的侧边栏不应该可用,而应该只显示自定义 toc.yml 提供的导航。我可以在自定义文件夹中创建一个新的自定义 TOC 并导航到页面,但是当加载 html 页面时(当然)会显示完整生成的 TOC.yml 的导航栏。
阅读文档。创建了自己的 TOC 文件(正在工作),但我没有找到使用自定义 TOC.yml 生成的 iso 的选项。试图排除docfx.json中的toc.yml。
{
"metadata": [
{
"src": [
{
"files": [
"LIB/myassembly.dll"
],
"include": [""],
"exclude": [
"**/toc.yml"
],
"cwd": "../output/Debug/"
},
{
"files": [
"**.cs"
],
"exclude": [
],
"cwd": "../../../TestScripting/Scripts"
}
],
"dest": "api",
"force": true
}
],
"build": {
"content": [{
"files": [
"api/**.yml"
]
},
{
"files": [
"scripting/index.md",
"scripting/toc.yml",
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"resource": [{
"files": [
"images/**"
],
"exclude": [
"obj/**",
"_site/**"
]
}],
"overwrite": [{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}],
"dest": "../Doc",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default","darkfx/darkfx"
],
"postProcessors": [],
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false
}
}
预期的结果是:每个生成的html文件显示的导航栏都应该基于自定义的toc.yml。
解决方案
推荐阅读
- php - VisualStudioCode + php:为代码完成指定“包含路径”
- wso2 - WSO2:如何使用 API 获取用户信息
- vb6 - 如何在 Visual Basic 的代码中禁用 X 按钮
- javascript - 我想详细了解这个函数(.on())的含义
- django - DJANGO + SAML2 + CSRF
- javascript - Javascript:检查屏幕宽度并删除 HTML 元素
- wordpress - 如何将插件简码打印到 wordpress 管理页面
- docker - 如何在 Docker 容器中为 kubectl 生成 admin.conf 文件
- python - 在树莓派中安装 QtVirtualkeyboard?
- asp.net - OWIN 使用什么机制来确定用户在阅读其声明之前已通过身份验证?