jazzy is a command-line utility that generates documentation for Swift or Objective-C. 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. Jazzy can also generate documentation from compiled Swift modules using their symbol graph instead of source code. You need development tools to build the project you wish to document. Jazzy supports both Xcode and Swift Package Manager projects. Jazzy expects to be running on macOS. Run jazzy from your command line. Run jazzy -h for a list of additional options. Swift documentation is written in markdown and supports a number of special keywords. You can set options for your project’s documentation in a configuration file, .jazzy.yaml by default.
Features
- Jazzy can render math equations written in LaTeX embedded in your markdown
- Swift documentation is generated by default
- Three themes are provided with jazzy
- By default, jazzy looks for one of README.md, README.markdown
- Any files found matching the file pattern will be parsed and included as a document with the type 'Guide' when generated
- By default Jazzy does not create separate web pages for declarations that do not have any members
Project Samples
