documentation - 如何使用 DocFx 创建可搜索的代码文档中央存储库

Question

我希望使用 DocFx 为我们所有已发布的 API 文档创建一个中央存储库。我有通过我的构建(使用 TFS)自动生成并通过我的版本(使用 Octopus)发布的文档，对于多个单独的站点来说都很好。但是，我想将它完全拉到一个位置。想法是，通过父站点，您可以过滤任何单个站点中的内容，而无需深入查看它们。你有关于如何做到这一点的建议吗？

此外，在同一个文档存储库中，我想提供在我们投资组合中的数百个项目中搜索所有元数据(项目级文档)的功能。这将使我们的 BA、DEV 和 QA 团队更容易访问我们所有系统的功能。我喜欢 DocFx 中内置的“过滤”功能，但我想要对所有元数据进行全文搜索。你对这个功能也有推荐吗？

Answer 1

要更改 docfx 输出的位置，请编辑 docfx.json文件并指定 dest值(value)。默认为 "dest": "_site" .如需更多格式指导，请引用:https://dotnet.github.io/docfx/tutorial/docfx.exe_user_manual.html .

关于全文搜索，只需确保 ExtractSearchIndex 即可。后处理器被调用(为了生成一个 index.json 关键字文件)并且全局 _enableSearch值设置为 true在 docfx.json文件。该文件的片段如下所示:

"postProcessors": [ "ExtractSearchIndex" ],
"globalMetadata": {
  "_enableSearch": "true"
}