從 6.0.9 版本開始，Spring Framework 參考文件網站是使用 Antora 生成的。這是一個重大的變更，帶來了許多改進。這篇部落格文章提供了關於此變更的背景資訊。

概觀

長期以來，Spring Framework 參考文件有兩個版本，一個是單頁版本，另一個是多頁版本。單頁版本非常龐大，但通常因為能夠使用 Ctrl+F 搜尋而受到青睞。多頁版本提供了結構，但導航和搜尋都很困難。例如，請參閱 4.3.x 版本的單頁和多頁版本。

在 5.0 版本中，我們切換到單一版本，將文件分成幾個高階章節，作為單頁和多頁版本之間的中間方案。您仍然可以在章節內使用 Ctrl+F，同時任何一頁的內容都不像完整文件那麼龐大。在這個版本中，我們還增加了左側導航欄，以便輕鬆瀏覽內容。請參閱 5.3.x 版本的範例。

理想情況下，內容應該更結構化，具有更多唯一的 URL，並且易於搜尋。Google 擅長尋找內容，但由於同一內容有多個版本，並且 URL 隨時間推移發生了一些變化，因此可能會變得具有挑戰性。整合的搜尋功能是更好的替代方案。

然後還有像 這個問題 這樣的疑問，關於從舊版本新增連結到最新版本，這看起來很簡單，但需要更進階的文件網站，該網站能夠識別多個版本。

這就是 Antora 的用武之地。在過去幾年中，Spring 團隊和 Antora 團隊合作創建了一個新的文件發佈系統，以滿足 Spring 專案的需求，包括上述需求以及現代文件網站所期望的其他需求。

我們剛開始使用此整合，您可以在 https://spring-docs.dev.org.tw/spring-framework/reference/ 看到結果。

改進

首先要注意的是右上角的下拉式選單，用於選擇版本。我們稍後會回到確切的版本列表，但如果您切換到目前版本以外的版本，您會在頁面頂部看到警告，並附有最新版本的連結。

同樣在右上角的搜尋框是我個人最喜歡的功能。基於 Algolia Docsearch 的整合搜尋功能，讓您可以在文件中搜尋，而無需求助於 Google 搜尋或載入完整內容才能使用 Ctrl+F。

注意： 搜尋目前使用預設的 Docsearch UI，僅顯示 5 個結果。我們正在積極開發自訂 UI，並將在準備就緒後切換到它！

在同一個區域，您還會看到「編輯此頁面」連結，讓您可以輕鬆提交特定頁面的文件更新。

內容現在已結構化，並分解為反映文件結構的唯一 URL。左側有全域導航，主要內容的右側有本地導航，頂部還有麵包屑導航。

還有更多不太明顯的好處。例如，文件變更不依賴於下一個版本發佈，而是立即部署到文件中。

版本

6.0.x 分支和 main 分支（目前為 6.1.x）已遷移到 Spring Antora 整合，文件網站具有這些版本。我們不打算遷移以前的版本，而且在任何情況下，唯一其他目前活動的分支是 5.3.x。

現有連結

現有的 6.0.x、6.1.x 和「current」參考文件連結會永久重新導向到新的參考文件。

其他 Spring 專案呢？

Spring Security 已經使用 Antora 一段時間了。我們計劃遷移其他專案。還有進一步整合的計劃，不僅跨版本，而且跨 Spring 專案。

更多資訊

請繼續關注未來幾週內發佈的另一篇部落格文章，該文章將更深入地探討所有這些內容。