Skip to content

Commit 6d20cc6

Browse files
committed
📝 docs: 更新 DocFX 配置以优化 API 文档生成
- 添加多个配置选项以控制 API 文档生成过程 - 设置 namespaceLayout 为 flattened,简化命名空间结构 - 添加 overwrite 配置以指定要覆盖的文件和排除的目录 - 更新 globalMetadata 和 template 配置以适应新设置
1 parent d50847c commit 6d20cc6

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

docs/docfx.json

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@
1010
]
1111
}
1212
],
13-
"dest": "api"
13+
"dest": "api",
14+
"includePrivateMembers": false,
15+
"disableGitFeatures": false,
16+
"disableDefaultFilter": false,
17+
"noRestore": false,
18+
"namespaceLayout": "flattened"
1419
}
1520
],
1621
"build": {
@@ -31,16 +36,31 @@
3136
]
3237
}
3338
],
34-
"output": "_site",
35-
"template": [
36-
"default",
37-
"modern"
39+
"overwrite":[
40+
{
41+
"files":[
42+
"apidoc/**.md"
43+
],
44+
"exclude": [
45+
"obj/**",
46+
"_site/**"
47+
]
48+
}
3849
],
50+
"output": "_site",
3951
"globalMetadata": {
4052
"_appName": "Bing.Utils",
4153
"_appTitle": "Bing.Utils",
4254
"_enableSearch": true,
4355
"pdf": true
44-
}
56+
},
57+
"globalMetadataFiles": [],
58+
"fileMetadataFiles": [],
59+
"template": [
60+
"default",
61+
"modern"
62+
],
63+
"postProcessors": [],
64+
"disableGitFeatures": false
4565
}
4666
}

0 commit comments

Comments
 (0)