领先一步
VMware 提供培训和认证,助您加速进步。
了解更多从 6.0.9 版本开始,Spring Framework 参考文档站点是使用 Antora 生成的。这是一个重大变化,带来了许多改进。这篇博客文章提供了相关的背景信息。
长期以来,Spring Framework 参考文档有两个版本,一个单页版和一个多页版。单页版非常大,但通常因其通过 Ctrl+F 搜索的功能而备受青睐。多页版提供了结构,但难以导航和搜索。例如,请参见 4.3.x 版本的单页版和多页版。
在 5.0 版本中,我们切换到了单一版本,将文档分成几个高级别部分,作为单一版本和多页面版本之间的一种折衷方案。你仍然可以在一个部分内使用 Ctrl+F,而这些页面中的任何一页内容都不像完整文档那么大。在这个版本中,我们还添加了左侧导航,以便于内容导航。请参阅 5.3.x 中的示例。
然而,理想情况下,内容应该更结构化,拥有更多独特的 URL,并且易于搜索。谷歌善于查找内容,但由于同一内容有多个版本以及随着时间的推移一些 URL 发生了变化,这可能会变得具有挑战性。集成搜索功能是更好的替代方案。
然后还有一些问题,比如这个议题,关于从旧版本到最新版本添加链接,这看起来很简单,但需要一个更高级的文档网站,它能够识别多个版本。
这就是 Antora 发挥作用的地方。在过去的几年里,Spring 团队和 Antora 团队合作创建了一个新的文档发布系统,以满足 Spring 项目的需求,包括上述以及现代文档网站所期望的其他功能。
我们刚刚开始使用这个集成,你可以在 https://docs.springjava.cn/spring-framework/reference/ 看到结果。
首先要注意的是右上角的版本选择下拉菜单。我们稍后会回到确切的版本列表,但如果你切换到当前版本之外的版本,你会在页面顶部看到一个警告,其中包含指向最新版本的链接。
搜索框,也在右上角,是我个人最喜欢的功能。一个基于 Algolia Docsearch 的集成搜索功能,让你无需诉诸谷歌搜索或加载完整内容即可使用 Ctrl+F,即可在文档中进行搜索。
注意: 搜索目前使用的是默认的 Docsearch UI,它只显示 5 个结果。我们正在积极开发一个自定义 UI,并将在准备就绪时切换到它!
在同一区域,你还会看到一个“编辑此页面”链接,这使得提交特定页面的文档更新变得容易。
内容现在已结构化并分解为反映文档结构的唯一 URL。主内容的左侧是全局导航,右侧是局部导航,顶部还有面包屑导航。
还有更多不那么明显的好处。例如,文档更改不依赖于下一个发布,而是立即部署到文档中。
6.0.x 分支和主分支(目前是 6.1.x)已迁移到 Spring Antora 集成,文档网站包含这些版本。我们不打算迁移以前的版本,而且无论如何,目前唯一活跃的其他分支是 5.3.x。
现有的 6.0.x、6.1.x 和“current”参考文档链接已通过永久重定向重定向到新的参考文档。
Spring Security 已经使用 Antora 一段时间了。我们也计划迁移其他项目。还有计划不仅在版本之间,而且在 Spring 项目之间进行进一步的集成。
敬请关注未来几周内发布的另一篇博客文章,它将深入探讨所有这些内容。