如何通过修改DocFX的docfx.json调整侧边目录项名称？

方法1：在docfx.json中直接配置自定义名称 #

在docfx.json的build节点下的api内容配置里，你可以通过name字段直接为指定的命名空间、类或接口设置自定义显示标题，替代默认的名称。

示例配置：

{
  "build": {
    "content": [
      {
        "files": ["**/*.csproj"],
        "src": "../src",
        "dest": "api",
        "properties": {
          "TargetFramework": "net6.0"
        },
        "name": {
          "MyApp.Core": "核心业务模块",
          "MyApp.Core.UserService": "用户管理服务",
          "MyApp.Data.DbContext": "数据库上下文"
        }
      }
    ]
  }
}

配置完成后，重新运行构建命令，生成的api/toc.yml里对应项的标题会自动替换为你设置的自定义名称。

方法2：用过滤配置文件实现精细化重命名 #

如果需要批量处理或更复杂的匹配规则，可以通过filterConfig.yml文件来配置：

1. 先在docfx.json中指定过滤文件路径：

{
  "build": {
    "content": [
      {
        "files": ["**/*.csproj"],
        "src": "../src",
        "dest": "api",
        "filter": "filterConfig.yml"
      }
    ]
  }
}

2. 在同级目录创建filterConfig.yml，添加重命名规则：

apiRules:
- include:
    uidRegex: ^MyApp\.Services.*
  name: "业务服务层"
- include:
    uid: MyApp.Utils.Encryption
  name: "加密工具类"

这里通过uidRegex（正则匹配）或uid（精确匹配）定位目标项，再用name字段设置自定义标题。

注意事项 #

• 修改配置后，务必删除已生成的api目录和toc.yml文件，再重新运行docfx docfx_project/docfx.json，避免旧文件覆盖新配置的结果。
• 不要直接手动修改生成的toc.yml，下次构建时会被自动覆盖，必须通过配置文件实现持久化修改。

内容的提问来源于stack exchange，提问作者Cracho