jazzy is a command-line utility that generates documentation for Swift or Objective-C
Both Swift and Objective-C projects are supported.
Objective-C support was recently added, so please report any issues you find.
Instead of parsing your source files,
jazzy hooks into Clang and
SourceKit to use the AST representation of your code and
its comments for more accurate results. The output matches the look and feel
of Apple’s official reference documentation, post WWDC 2014.
- A version of Xcode (6.x or 7.x) capable of building the project you wish to document. It must be installed in a location indexed by Spotlight.
[sudo] gem install jazzy
jazzy from your command line. Run
jazzy -h for a list of additional options.
If your Swift module is the first thing to build, and it builds fine when running
xcodebuild without any arguments from the root of your project, then just running
jazzy (without any arguments) from the root of your project should succeed too!
You can set options for your project’s documentation in a configuration file,
.jazzy.yaml by default. For a detailed explanation and an exhaustive list of
all available options, run
jazzy --help config.
Swift header documentation is written in markdown and supports a number of special keywords. For a complete list and examples, see Erica Sadun's post on Swift header documentation in Xcode 7.
For Objective-C documentation the same keywords are supported, but note that the format
is slightly different. In Swift you would write
- returns:, but in Objective-C you write
@return. See Apple's HeaderDoc User Guide for more details. Note:
jazzy currently does not support all Objective-C keywords listed in this document.
Swift documentation is generated by default.
This is how Realm Swift docs are generated:
jazzy \ --clean \ --author Realm \ --author_url https://realm.io \ --github_url https://github.com/realm/realm-cocoa \ --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \ --module-version 0.96.2 \ --xcodebuild-arguments -scheme,RealmSwift \ --module RealmSwift \ --root-url https://realm.io/docs/swift/0.96.2/api/ \ --output docs/swift_output \ --theme docs/themes
To generate documentation for Objective-C headers, you must pass the following parameters to jazzy:
--sdk [iphone|watch|appletv][os|simulator]|macosx(optional, default value of
This is how Realm Objective-C docs are generated:
jazzy \ --objc \ --clean \ --author Realm \ --author_url https://realm.io \ --github_url https://github.com/realm/realm-cocoa \ --github-file-prefix https://github.com/realm/realm-cocoa/tree/v0.96.2 \ --module-version 0.96.2 \ --umbrella-header Realm/Realm.h \ --framework-root . \ --module Realm \ --root-url https://realm.io/docs/objc/0.96.2/api/ \ --output docs/objc_output \ --theme docs/themes
This is how the AFNetworking docs are generated:
jazzy \ --objc \ --author AFNetworking \ --author_url http://afnetworking.com \ --github_url https://github.com/AFNetworking/AFNetworking \ --github-file-prefix https://github.com/AFNetworking/AFNetworking/tree/2.6.2 \ --module-version 2.6.2 \ --umbrella-header AFNetworking/AFNetworking.h \ --framework-root . \ --module AFNetworking
Two themes are provided with jazzy:
apple (default) and
Here's an example built with
Here's an example built with
You can specify which theme to use by passing in the
--theme option. You can
also provide your own custom theme by passing in the path to your theme
Only extensions are listed in the documentation?
jazzy only documents public declarations. To generate documentation
for declarations with a lower accessibility level (
--min-acl flag to
Please review jazzy's contributing guidelines when submitting pull requests.
jazzy is composed of two parts:
- The parser, SourceKitten (written in Swift)
- The site generator (written in ruby)
To build and run jazzy from source:
- Install bundler.
bundle installfrom the root of this repo.
- Run jazzy from source by running
Instructions to build SourceKitten from source can be found at SourceKitten's GitHub repository.
- Generate source code docs matching Apple's official reference documentation
- Support for standard Objective-C and Swift documentation comment syntax
- Leverage modern HTML templating (Mustache)
- Leverage the power and accuracy of the Clang AST and SourceKit
- Support for Dash docsets
- Support Swift and Objective-C (mixed projects are a work in progress)
This project is released under the MIT license.