從 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://docs.springframework.tw/spring-framework/reference/ 檢視結果。

改進

首先注意到的是右上角的版本選擇下拉選單。我們稍後會回到具體的版本列表，但如果你切換到非當前版本，你會在頁面頂部看到一個警告，其中包含一個指向最新版本的連結。

搜尋框也在右上角，這是我個人最喜歡的功能。這是一個基於 Algolia Docsearch 的整合搜尋功能，它允許你在文件中進行搜尋，而無需依賴 Google 搜尋或載入全部內容才能使用 Ctrl+F。

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

在同一區域，你還會看到一個“編輯本頁”連結，透過它你可以輕鬆地提交特定頁面的文件更新。

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

還有更多不太明顯的優勢。例如，文件更改不再依賴於下一個版本釋出，而是會立即部署到文件網站。

版本

6.0.x 分支和主分支（當前為 6.1.x）已遷移到 Spring Antora 整合，文件網站包含這些版本。我們不打算遷移以前的版本，無論如何，目前唯一活躍的其他分支是 5.3.x。

現有連結

現有的 6.0.x、6.1.x 和“當前”參考文件連結將透過永久重定向指向新的參考文件。

其他 Spring 專案如何？

Spring Security 已經使用 Antora 一段時間了。我們也計劃遷移其他專案。此外，還計劃進一步整合，不僅是跨版本，還包括跨 Spring 專案。

更多資訊

請留意未來幾周內將釋出的另一篇博文，它將更深入地探討這一切。