2017-07-25 87 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,併爲搜索頁面收集它們的中心位置。

相關問題