Swift Package Index

更新： 此博客文章中的信息已被我们的官方文档取代。请参考该文档，而不是此博客文章。

我们今天有更多与文档相关的新闻要宣布！

我们很高兴看到这么多包作者选择在 Swift Package Index 上托管他们的包文档。现在有超过 180 个包选择让我们托管版本化的文档，我们认为这对 Swift 生态系统来说是个极好的消息。

我们的托管文档生成是在 Web 上托管 DocC 文档的最简单方法，但有些项目有更复杂的要求或完善的文档网站。因此，我们很高兴地宣布 Swift Package Index 现在支持外部文档链接！

如果您是包作者，并且想要配置您的包页面以链接到您的外部文档，请在您的包存储库根目录中添加或修改 .spi.yml 文件，并告诉我们访问者在哪里查找文档时进行重定向。

以下是如何操作

version: 1
external_links:
  documentation: "https://example.com/package/documentation/"

这是一个来自 GRDB 的 示例，他们已经选择加入这项新功能。

就包页面的访问者而言，文档的存放位置没有任何区别。访问者仍然在包页面侧边栏中看到一个“Documentation”（文档）链接。

我们还为任何拥有由我们托管或外部托管的文档的包创建了一个通用文档链接。对于任何有文档的包，请导航到

https://swiftpackageindex.cn/{owner}/{repository}/documentation

当然，替换 {owner} 和 {repository}，它将重定向到我们的托管文档或外部文档。