jazzy
A command-line tool that generates Apple-style API documentation for Swift and Objective-C projects.
What is jazzy?
jazzy is a command-line utility that generates API documentation for Swift and Objective-C projects. It produces documentation that matches Apple's official reference style by using the Clang AST and SourceKit for accurate code analysis instead of simple text parsing. It solves the problem of creating professional, consistent documentation for Apple platform developers.
Swift and Objective-C developers, particularly those building libraries, frameworks, or SDKs for Apple platforms (iOS, macOS, etc.) who need to generate public API documentation.
Developers choose jazzy because it produces documentation that looks exactly like Apple's official references, supports both Swift and Objective-C with high accuracy, integrates with Dash for offline browsing, and offers extensive customization through themes and configuration.
Overview
Soulful docs for Swift & Objective-C
Use Cases
Best For
- Generating API documentation for open-source Swift libraries
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.