2017-07-25 35 views
3

我正在寻找使用DocFx为我们所有发布的API文档创建中央存储库。我有通过我的构建(使用TFS)自动生成的文档,并通过我的发布(使用Octopus)发布,可以适用于多个单独的网站。但是,我想要在一个位置完全拉动它。我们的想法是,通过父网站,您可以在任何单个网站中过滤内容,而无需深入研究这些内容。你有建议如何做到这一点?如何使用DocFx创建代码文档的可搜索中央存储库

另外,在这个相同的文档库中,我希望能够通过我们投资组合中数百个项目中的所有元数据(项目级文档)进行搜索。这将使我们的BA,DEV和QA团队更容易获得我们所有系统的功能。我喜欢DocFx中内置的“过滤”功能,但我希望对所有元数据进行全文搜索。你是否也有这个功能的建议?

+0

DocFX使用https://lunrjs.com进行搜索,您可以将它扩展为一种方式,以便搜索可以跨所有“子网站”使用。 – bitbonk

回答

0

关于第一个问题:

我想你希望是什么样的了.NET API Browser。此页面背后的源代码不对公众开放,因此您需要自己创建此页面,通过从多个站点收集xrefmap.yml,并将所需数据提取到此页面。

关于第二个问题:

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

相关问题