Jazzy

What Jazzy is

Jazzy is a command-line tool for generating API documentation from Swift and Objective-C projects. It reads code and comments through Clang and SourceKit, using the code’s AST, and produces browsable HTML designed to resemble Apple’s reference documentation. It can also generate a Dash docset and versioned documentation. Inputs include Swift and Objective-C source, Xcode and 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 can include cross-references, LaTeX math, and extra Markdown guides; themes, categories, and other options can be customized in a .jazzy.yaml file. Jazzy is free and open source under the MIT license, and Realm Inc. maintains and funds the project. It supports macOS and Linux, though its bundled SourceKitten binary is built for macOS. Linux users must install and build SourceKitten separately before generating SwiftPM documentation. In Swift mode, public and open declarations are documented by default; symbol-graph mode exposes comments only for public declarations.

Who it suits

Jazzy suits developers creating reference documentation for Swift or Objective-C code, projects, modules, or supported documentation inputs. It is also suited to teams that want HTML or Dash output and customizable themes or categories.

Limits

In Swift mode, Jazzy documents public and open declarations by default. Symbol-graph mode exposes comments only for public declarations. On Linux, SourceKitten must be installed and built separately for SwiftPM documentation.

Getting started

1. Open the Jazzy project website on GitHub.
2. Use macOS or Linux as the working platform.
3. For Linux SwiftPM documentation, install and build SourceKitten separately.
4. Choose a supported input such as source, an Xcode or Swift Package Manager project, or a compiled module.
5. Configure options in .jazzy.yaml if needed, then generate HTML or a Dash docset.

Verdict

Choose Jazzy for API references from Swift or Objective-C inputs, especially when HTML, Dash docsets, or versioned documentation fit the workflow. Linux SwiftPM users need to prepare SourceKitten separately, and symbol-graph mode limits exposed comments to public declarations.