Jazzy

What Jazzy is

Jazzy is a free, MIT-licensed command-line utility for generating Swift and Objective-C documentation. It reads code and comments through Clang and SourceKit’s representation of the code structure, and produces browsable HTML styled to resemble Apple’s reference documentation. It can also create a Dash docset. Supported 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 and categories can be customized, with settings in a `.jazzy.yaml` file. Jazzy supports macOS and Linux, but its bundled SourceKitten binary is built for macOS. Linux users must separately install and build SourceKitten before generating SwiftPM documentation. By default, Swift mode documents public and open declarations, while symbol-graph mode exposes comments only for public declarations. Realm Inc. maintains and funds the project.