Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

Jazzy

github.com

  • Free plan
  • macOS
  • Linux
7.2 Club score Visit github.com

What Jazzy is

Jazzy is a free, MIT-licensed command-line utility for generating API documentation from Swift and Objective-C. It reads source code and comments through Clang and SourceKit’s abstract syntax tree processing, then produces browsable HTML intended to resemble Apple reference documentation. Jazzy can also create a Dash docset and supports versioned documentation. Inputs include Swift or Objective-C source, Xcode projects, Swift Package Manager projects, compiled Swift modules, frameworks, symbol graph files, SourceKitten JSON, and Markdown guides. Compiled Swift modules can be documented through symbol graphs. Generated material may include cross-references, LaTeX mathematics, and Markdown guides, while themes and categories can be customized through a .jazzy.yaml file. The tool supports macOS and Linux. Its bundled SourceKitten binary is built for macOS; Linux users must install and build SourceKitten separately before generating SwiftPM documentation. Swift mode documents public and open declarations by default.

Who it suits

Jazzy suits Swift and Objective-C developers who need API references from source, projects, compiled modules, or related documentation inputs. It is also useful when HTML or Dash output and configurable themes are required.

Good to know, and what to watch

  • Generates HTML documentation and Dash docsets
  • Supports Swift and Objective-C inputs
  • Works with Xcode and Swift Package Manager projects
  • Offers themes, categories, and configuration options
  • Includes cross-references and LaTeX math rendering
  • Linux requires separately built SourceKitten
  • Swift mode defaults to public and open declarations
  • No free trial is listed

Jazzy

Free

Open source

The verdict

Jazzy covers varied Swift and Objective-C documentation inputs and produces Apple-style HTML or Dash output. Linux setup requires extra SourceKitten work, and default visibility limits should be checked before generation.

What the maker publishes

Build tools
The project supports Xcode and Swift Package Manager projects. source
Customization
Options can be set in a .jazzy.yaml configuration file, and the tool supports custom themes and categories. source
Dash
Along with browsable HTML documentation, Jazzy can create a docset for the Dash app. source
Documentation features
Jazzy supports cross-references, LaTeX math rendering, and additional Markdown guides in generated documentation. source
License and maintainer
Jazzy is released under the MIT license and is maintained and funded by Realm Inc. source
Limitations
In Swift mode, Jazzy documents public and open declarations by default; symbol-graph mode exposes comments only for public declarations. source
Linux support
On Linux, users must separately install and build SourceKitten before generating SwiftPM documentation. source
macOS requirement
Jazzy expects to run on macOS, where its bundled SourceKitten binary is built to run. source
Output style
Generated documentation is designed to match the look and feel of Apple’s reference documentation. source
Parsing
It uses Clang and SourceKit to read code and comments through the code’s AST representation. source
Purpose
Jazzy is a command-line utility that generates documentation for Swift and Objective-C. source
Support
The README links to installation troubleshooting guidance and asks users to report code-of-conduct concerns to [email protected]. source
Swift modules
Jazzy can generate documentation from compiled Swift modules using symbol graphs. source

Checked against the maker's pages on 8 Oct 2026.