如何配置DocFX的docfx.json以引用外部项目路径？

没问题，我之前也踩过这个坑——DocFX默认盯着src文件夹找项目，自定义路径得把metadata配置的细节调整到位。你当前的配置还在用默认的src/**.csproj路径，自然找不到你的项目文件，调整方式如下：

方式1：直接指定项目文件的绝对路径 #

把files字段改成你项目的实际绝对路径，注意用正斜杠（/）或者转义反斜杠（\），同时一定要排除bin和obj文件夹，避免编译产物干扰解析：

"metadata": [
  {
    "src": [
      {
        "files": ["C:/Test/ConsoleApp1/ConsoleApp1/*.csproj"],
        "exclude": ["**/bin/**", "**/obj/**"]
      }
    ],
    "dest": "api"
  }
]

方式2：先指定源目录，再匹配项目文件 #

这种方式逻辑更清晰，适合后续要添加多个项目的场景：

"metadata": [
  {
    "src": [
      {
        "src": "C:/Test/ConsoleApp1/ConsoleApp1",
        "files": ["*.csproj"],
        "exclude": ["**/bin/**", "**/obj/**"]
      }
    ],
    "dest": "api"
  }
]

用相对路径的情况（如果docfx.json和项目有固定相对位置） #

• 如果你的docfx.json和.csproj文件在同一文件夹（C:\Test\ConsoleApp1\ConsoleApp1），直接写：

  "files": ["*.csproj"]
  

• 如果docfx.json在项目的上级目录（比如C:\Test\ConsoleApp1），写：

  "files": ["./ConsoleApp1/*.csproj"]
  

配置完后，先跑docfx metadata命令测试，如果能在api目录下生成对应的yml文件，说明路径配置正确了，之后执行docfx build就能生成完整文档啦。

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