使用 DocC 创建出色的文档

敬请探索如何使用 DocC 直接在 Xcode 中构建和共享适用于 Swift 软件包和框架的文档。我们将展示如何从您自己的代码或您依赖的第三方代码开始生成文档,并使用 Markdown 编写和设置格式。您将了解撰写文章的最佳实践,包括如何组织文档,也将了解如何创建自动托管的链接以将您的文档连接在一起。

此外,我们还将带您了解如何配置网页服务器来托管生成的 DocC 存档,帮助您学习使用 xcodebuild 工具来自动生成文档并保持网页内容同步和更新。

最后,还会探索如何使用 DocC 从头开始创作沉浸式教程。我们将演示如何通过 DocC 语法将丰富的指令、示例代码和图像组合在一起,展示 Swift 框架的实际效果。此外,我们将讨论如何创建渐进式培训,来提供交互式的学习,并帮助您框架中的用例能被更好的理解。

认识 Xcode 中的 DocC 文档

Watch now

托管和自动化 DocC 文档

Watch now

提升 Xcode 中 DocC 文档的质量

Watch now

使用 DocC 构建交互教程

Watch now

SlothCreator: Building DocC Documentation in Xcode

DocC