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