Swift Package Index 标志。Swift Package Index

追踪 Swift 6 严格并发检查在数据竞争安全方面的采用情况。有多少包已为 Swift 6 做好准备

自定义 DocC 文档主题


本周末在 Swift Package Index Discord 服务器 上的一次有趣的对话,促使我们中的一些人深入研究 DocC 对自定义主题的支持是否适用于我们的自动包文档托管系统。

好消息是我们确实支持它!我们对生成的 DocC 代码进行的处理非常少,因此我们支持 DocC 生成的所有内容。

这一切的起因是 Cihat Gündüz 想要自定义他的 HandySwift 包的标头。这是结果

The HandySwift documentation showing a customised theme with a gradient background and a logo image.

我们认为您也会同意这是一个比默认外观更好的改进。您可以在网站上查看此文档的实时版本,如果您想美化您包的文档,请访问 DocC 文档关于外观自定义的部分,了解如何操作。

如果您利用此主题自定义,请通过 我们的 Mastodon 帐户给我们留言,我们会转发您的回复。

注意:如果您决定自定义包文档的主题,测试它的最佳方法不是在 SPI 网站上实时进行。我们会合并来自包默认分支的提交,并且对于该分支,最多每 24 小时构建一次文档(我们总是立即构建标记的发布版本)。测试主题自定义的最佳方法是在本地使用 DocC 预览命令生成您的 Web 文档,使其在本地看起来符合您的喜好,然后推送它,以便我们为您构建它。


关于此博客

Swift Package Index 是 Swift 包的搜索引擎和元数据索引。我们的主要目标是帮助您更好地决定要包含在您的应用和项目中的依赖项。如果您是新来的用户,最好的入门方式是搜索包