从 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.org.cn/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 项目。

更多信息

请留意未来几周内将发布的另一篇博文，它将更深入地探讨这一切。