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

Question

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

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

Answer 1

要更改 docfx 输出的位置，请编辑docfx.json文件并指定dest值。默认情况下是"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"
}

Answer 2

对于你的第一个问题：

我认为您所期望的就像.NET API Browser。该页面背后的源代码不公开，因此您需要自己创建该页面，通过从多个站点收集xrefmap.yml，并将所需的数据提取到该页面中。

对于你的第二个问题：

DocFX使用Luna扫描所有输出文件并生成一个索引文件index.json供以后搜索使用。就您而言，您应该只想将搜索范围限制在您定义的元数据中。DocFX 默认也不支持此功能。您还可以在您的中心位置使用 Luna 来搜索这些元。您可以首先为每个项目创建特定的index.json项目，并为搜索页面收集它们的中心位置。