Jazzy
What it is
Jazzy is a free, MIT-licensed command-line utility that generates documentation for Swift and Objective-C. It reads code and comments through Clang and SourceKit using the code’s abstract syntax tree, then produces browsable HTML styled after Apple reference documentation. It can also create a Dash docset and supports versioned documentation. Inputs include Swift and Objective-C source, Xcode projects, Swift Package Manager projects, compiled Swift modules, frameworks, symbol graph files, SourceKitten JSON, and Markdown guides. For compiled Swift modules, Jazzy can use symbol graphs. Generated documentation supports cross-references, LaTeX mathematics, and extra Markdown guides. Custom themes and categories are available, with settings stored in a .jazzy.yaml file. Jazzy supports Xcode and Swift Package Manager workflows. It runs on macOS and Linux; its bundled SourceKitten binary is built for macOS, while Linux users must install and build SourceKitten separately before SwiftPM documentation. In Swift mode, public and open declarations are documented by default.
For and against
For
- Supports Swift and Objective-C
- HTML and Dash docset output
- Many supported source inputs
- Custom themes and categories
- Versioned documentation support
Against
- Linux requires separately built SourceKitten
- Public declarations are documented by default
- macOS is expected for bundled SourceKitten
- Focused on Swift and Objective-C
The verdict
Jazzy provides flexible API documentation generation with Apple-style HTML, Dash output, and broad input support. Linux users should plan for separate SourceKitten setup, and teams should review its declaration-visibility defaults.
Who it suits
Jazzy suits Swift and Objective-C developers who need API references from source, projects, compiled modules, or documentation files. It is useful when HTML pages or Dash output and versioned documentation are required.
Plans and prices
Jazzy
MIT-licensed open-source command-line utility
Read 8 Oct 2026 · github.com
On the record
- Build tools
- The project supports Xcode and Swift Package Manager projects.github.com · read 8 Oct 2026
- Customization
- Options can be set in a .jazzy.yaml configuration file, and the tool supports custom themes and categories.github.com · read 8 Oct 2026
- Dash
- Along with browsable HTML documentation, Jazzy can create a docset for the Dash app.github.com · read 8 Oct 2026
- Documentation features
- Jazzy supports cross-references, LaTeX math rendering, and additional Markdown guides in generated documentation.github.com · read 8 Oct 2026
- License and maintainer
- Jazzy is released under the MIT license and is maintained and funded by Realm Inc.github.com · read 8 Oct 2026
- Limitations
- In Swift mode, Jazzy documents public and open declarations by default; symbol-graph mode exposes comments only for public declarations.github.com · read 8 Oct 2026
- Linux support
- On Linux, users must separately install and build SourceKitten before generating SwiftPM documentation.github.com · read 8 Oct 2026
- macOS requirement
- Jazzy expects to run on macOS, where its bundled SourceKitten binary is built to run.github.com · read 8 Oct 2026
- Output style
- Generated documentation is designed to match the look and feel of Apple’s reference documentation.github.com · read 8 Oct 2026
- Parsing
- It uses Clang and SourceKit to read code and comments through the code’s AST representation.github.com · read 8 Oct 2026
- Purpose
- Jazzy is a command-line utility that generates documentation for Swift and Objective-C.github.com · read 8 Oct 2026
- Support
- The README links to installation troubleshooting guidance and asks users to report code-of-conduct concerns to [email protected].github.com · read 8 Oct 2026
- Swift modules
- Jazzy can generate documentation from compiled Swift modules using symbol graphs.github.com · read 8 Oct 2026
