documentation-generation - DocFX 到 'src' 文件夹的相对路径

Question

我在 DocFX 配置中缺少一些东西 - 因此它不会生成正确的文档。

我有以下文件夹结构:

+Documentation
 |- _site
 |- api
 |- apidoc
 |- articles
 |- images
 |- src    <-- This folder is autogenerated by `docfx init` command as a folders above
  docfx.json
  index.md
  toc.md
+packages
 |- Microsoft.NETCore.Platforms.1.0.1
 |- ... other nuget folders
+src
 |- MyRealProject
   |- assets
   |- bin
   |- Commands
   |- obj
   |- Properties
   |- vendor      <- This folder should be excluded for documentation
   app.config
   MyRealProject.csproj
   MyRealProject.csproj.user
   Program.cs
+test
 |-MyRealProjext.XUnit
   |- bin
   |- obj
   |- Properties
   app.config
.gitattributes
.gitignore
.gitmodule
MyRealProject.sln

我的 docfx.json:

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "**/*.csproj"
          ],
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**",
            "vendor/**"
          ],
          "src": "../src"
        }
      ],
      "dest": "api"
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md"
        ]
      },
      {
        "files": [
          "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": "_site",
     "globalMetadataFiles": [],
     "fileMetadataFiles": [],
    "template": [
      "default"
     ],
    "postProcessors": [],
    "noLangKeyword": false
  }
}

运行命令 docfx build 生成没有错误的文档，但是当导航到 http://locahost:8080 打开目录列表而不是 index.html 来自 _site 文件夹。我的意思是我看到一个只有文件夹列表的网页: 接口(interface)/ 文档/ 文章/ 图片/ _地点/ ETC..甚至如果我进入 _site 文件夹并单击 index.html - 它确实会打开 docfx 生成的页面，但单击顶部的“Api 文档”会显示文本: TODO:将 .NET 项目添加到 src 文件夹并运行 docfx 以生成真正的 API 文档!

• 我应该在 docfx.json 中重新配置什么才能正确读取/src 文件夹而不是/Documentation/src 文件夹？
• 这是从 src/ 文件夹中排除 vendor/ 文件夹的正确方法吗？

Answer 1

我的错误。一切正常。

我正在使用从 Github 下载的代码并在本地编译。问题不在配置文件中(按预期工作)，而在模板生成中。出于某种原因，来自 Github 的代码甚至没有“默认”模板。因此，即使在我执行第一步之后:docfx.exe 元数据 -> 已生成元数据，但它从未转换为上下文表 (TOC)，因为缺少模板引擎。所以运行 docfx.exe build + serve 显示空站点。有一个单独的 Github “默认”模板页面