Swift-DocC

Swift-DocC 是一款 Swift 框架和包的文档编译器，旨在让编写和发布出色的开发者文档变得容易。

要查看 Swift-DocC 的实际应用示例，请访问 developer.apple.com。Apple 的许多开发者文档，从 参考文档 到 教程，以及 长篇内容，都是使用 Swift-DocC 构建的。

要了解有关此工具要点的更多信息，请参阅用户文档。

Swift-DocC 正在积极开发中。有关 Swift-DocC 项目的更多信息，请参阅介绍性博客文章此处。

贡献 Swift-DocC

Swift 论坛是获得 Swift-DocC 帮助和讨论未来计划的最佳场所。

作为一个开源项目，我们重视对此工具的任何贡献。请参阅贡献指南，以获取有关如何贡献和从源代码构建 DocC 的更多信息。

DocC 入门

docc 是 Swift-DocC 的命令行界面 (CLI)，并提供对生成和预览文档的支持。

根据您的用例，您可以通过多种方式使用 DocC

1. 用于通过 SwiftPM 文档化软件包

如果您想为您的 Swift 软件包生成文档，我们建议使用 Swift-DocC 插件。请参阅该插件的文档，以开始使用 构建、预览以及将您的文档发布到您的 网站 或 GitHub Pages。

2. 用于独立文档

如果您安装了 Xcode，建议使用 xcrun 命令生成文档。您可以通过在终端中调用 xcrun docc 来使 DocC 工作。

Swift-DocC 也包含在 macOS 和 Linux 的 Swift 工具链中。

要查看有关如何从 CLI 使用 DocC 的说明，请运行

docc --help

3. 用于使用 Xcode 文档化应用程序、框架和软件包

如果您想为您的项目生成 API 参考，您可以通过 Xcode 使用 DocC。请参阅 Xcode 文档，以了解如何入门的要点。

使用 Swift-DocC 编写和发布文档

如果您想了解如何编写和格式化文档，请参阅格式化您的文档内容。有关发布，请访问将文档分发给其他开发者。

要了解更多关于 Swift-DocC 内部工作原理的信息，请参阅CONTRIBUTING.md。

版本控制

Swift-DocC 的 CLI 工具 (docc) 已集成到 Swift 工具链中，并遵循 Swift 编译器的版本控制方案。

SwiftDocC 库的版本与 docc 分开。SwiftDocC 正在积极开发中，源代码稳定性不保证。

错误报告和功能请求

提交错误报告

Swift-DocC 使用 GitHub Issues 跟踪所有错误报告。当您提交错误报告时，我们要求您遵循提供的模板，并提供尽可能多的详细信息。

注意： 您可以使用此存储库中的 environment 脚本来收集有用的环境信息，通过运行以下命令将其粘贴到您的错误报告中

bin/environment

如果您可以确认当使用 main 分支中 Swift-DocC 的最新提交时（请参阅构建 Swift-DocC），该错误仍然发生，这将有助于我们更快地追踪到错误。

提交功能请求

对于功能请求，请随时提交 GitHub issue 或在 Swift 论坛上发起讨论。

如果您发现 Swift-DocC 可以通过改进来更好地满足您的需求，请不要犹豫提交功能请求。

所有面向用户的功能都必须在 Swift 论坛中讨论，然后才能默认启用。