从 6.0.9 版本开始，Spring 框架参考文档站点使用 Antora 生成。这是一个重大变化，带来了许多改进。这篇博文提供了关于此的一些背景信息。

概述

长期以来，Spring 框架参考文档有两个版本，一个单页面版本和一个多页面版本。单页面版本非常大，但由于能够使用 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，该 UI 仅显示 5 个结果。我们正在积极开发自定义 UI，并在准备就绪时切换到它！

在同一区域，您还会看到一个“编辑此页面”链接，方便您为特定页面提交文档更新。

内容现在具有结构，并分解为反映文档结构的唯一 URL。左侧有全局导航，主要内容右侧有本地导航，顶部有面包屑导航。

还有一些不太明显的优势。例如，文档更改不依赖于下一个版本，而是立即部署到文档中。

版本

6.0.x 分支和主分支（当前为 6.1.x）已迁移到 Spring Antora 集成，并且文档站点具有这些版本。我们不打算迁移以前的版本，并且无论如何，当前唯一其他活动分支是 5.3.x。

现有链接

现有的 6.0.x、6.1.x 和“当前”参考文档链接将通过永久重定向重定向到新的参考文档。

其他 Spring 项目呢？

Spring Security 一直在使用 Antora。我们计划也将其他项目迁移过来。还计划进一步集成，不仅跨版本，而且跨 Spring 项目。

更多信息

敬请关注未来几周内发布的另一篇博文，其中将更深入地探讨所有这些内容。