realm/jazzy

这是什么？

核心功能

• 01通过读取 Clang 和 SourceKit 的 AST 及文档注释生成文档。
• 02支持 Xcode 与 Swift Package Manager 项目，并支持 Objective-C。
• 03可基于编译后的 Swift 模块的 symbol graph 生成文档。
• 04支持将多个模块合并到同一站点，并实现跨模块链接。
• 05通过 KaTeX 渲染 LaTeX 数学公式，并可包含 Markdown 指南。
• 06可生成 Dash docset，内置 apple、fullwidth、jony 三种主题。

适用场景

• 为 Swift 框架或 SDK 发布 API 参考文档。
• 为带有 umbrella header 的 Objective-C 库生成文档。
• 为一个应用及其扩展生成统一的文档站点。
• 生成可在 Dash 中离线浏览的 docset。

快速上手

1. 1

   通过 RubyGems 安装 jazzy

   [sudo] gem install jazzy
2. 2

   在 Swift 项目根目录运行 jazzy

   jazzy

使用前须知

• !Jazzy 需要在 macOS 上运行；在 Linux 上使用需要参考 README 中的额外说明。

收录于专题

标签

常见问题

jazzy 是什么？

一款命令行工具，为 Swift 和 Objective-C 项目生成 Apple 风格的 HTML API 文档。 jazzy 是一款为 Swift 和 Objective-C 代码生成 API 参考文档的命令行工具。它不直接解析源文件，而是借助 Clang 和 SourceKit 读取代码的 AST 以及文档注释，从而得到更准确的结果。生成的页面外观与 Apple 官方参考文档相近。

jazzy 可以免费使用吗？用的什么许可证？

jazzy 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。

jazzy 还在维护吗？

半年内有更新。jazzy 最近一次提交是在 2026年10月1日。

jazzy 适合用来做什么？

为 Swift 框架或 SDK 发布 API 参考文档。 为带有 umbrella header 的 Objective-C 库生成文档。 为一个应用及其扩展生成统一的文档站点。 生成可在 Dash 中离线浏览的 docset。

jazzy 怎么安装和运行？

通过 RubyGems 安装 jazzy: [sudo] gem install jazzy 在 Swift 项目根目录运行 jazzy: jazzy

在哪里获取 jazzy？

源代码和安装说明在 GitHub 上：https://github.com/realm/jazzy