# realm/jazzy

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/realm-jazzy).**

7,384 stars · 414 forks · Ruby · MIT

## Links

- GitHub: https://github.com/realm/jazzy
- Homepage: https://realm.io
- awesome-repositories: https://awesome-repositories.com/repository/realm-jazzy.md

## Description

Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets.

The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references.

The tool covers a broad capability surface including multi-language API generation for mixed Swift and Objective-C projects, documentation coverage tracking, and XML-based exports for the Dash documentation browser. It supports visual theming, symbol filtering, and the integration of source code links with precise line-range references.

## Tags

### Programming Languages & Runtimes

- [Swift API Documentation](https://awesome-repositories.com/f/programming-languages-runtimes/swift-api-documentation.md) — Generates searchable websites and technical references from Swift and Objective-C source code.
- [Cross-Module Symbol Linking](https://awesome-repositories.com/f/programming-languages-runtimes/cross-module-symbol-linking.md) — Maps declarations across multiple source modules to create a unified search index and hyperlinked reference site.
- [Multi-Language API Documentation](https://awesome-repositories.com/f/programming-languages-runtimes/multi-language-api-documentation.md) — Produces searchable websites and docsets from mixed Swift and Objective-C source code. ([source](https://github.com/realm/jazzy#readme))
- [Documentation Generators](https://awesome-repositories.com/f/programming-languages-runtimes/programming-language-varieties/programming-languages/systems-languages/objective-c/documentation-generators.md) — Processes Objective-C header files using compiler flags and SDK specifications to extract API documentation. ([source](https://github.com/realm/jazzy/blob/master/ObjectiveC.md))
- [Symbol Graph Analysis](https://awesome-repositories.com/f/programming-languages-runtimes/symbol-graph-analysis.md) — Extracts API metadata from compiled module files to accelerate the documentation generation process.

### Content Management & Publishing

- [Documentation Generators](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/documentation-tooling/generation-publishing/documentation-generators.md) — Provides a system that generates technical documentation by extracting and formatting information from source code. ([source](https://github.com/realm/jazzy/blob/master/.gitmodules))
- [Project Documentation](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/project-documentation.md) — Creates a unified documentation site providing technical guidance and API references for mixed-language projects.
- [Markdown Documentation](https://awesome-repositories.com/f/content-management-publishing/markdown-documentation.md) — Implements a rendering engine that converts markdown files into technical guides with LaTeX and custom themes.
- [Static Documentation Export](https://awesome-repositories.com/f/content-management-publishing/content-formats-exporting/export-formats/static-documentation-export.md) — Exports API definitions into standalone static files and XML feeds for offline browsing in Dash. ([source](https://github.com/realm/jazzy#readme))
- [Markdown Tools](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/markdown-markup-tools/markdown-tools.md) — Embeds custom markdown files as standalone guides with support for autolinks, callouts, and footnotes. ([source](https://github.com/realm/jazzy/blob/master/CHANGELOG.md))
- [Docset Export Formats](https://awesome-repositories.com/f/content-management-publishing/docset-export-formats.md) — Serializes extracted API data into XML feeds for offline browsing within the Dash documentation browser.
- [Docset Generators](https://awesome-repositories.com/f/content-management-publishing/docset-generators.md) — Produces XML feeds and docsets for offline browsing within the Dash documentation browser.

### Data & Databases

- [Multi-Source Content Aggregation](https://awesome-repositories.com/f/data-databases/multi-source-content-aggregation.md) — Merges technical API data from disparate source modules into a unified structure with shared search.

### Development Tools & Productivity

- [Compiled Module Analysis](https://awesome-repositories.com/f/development-tools-productivity/compiled-module-analysis.md) — Generates API documentation from compiled module files or frameworks using symbol graphs for faster processing. ([source](https://github.com/realm/jazzy/blob/master/README.md))
- [Cross-Module Documentation Unification](https://awesome-repositories.com/f/development-tools-productivity/cross-module-documentation-unification.md) — Unifies documentation for projects split across separate source modules into a single site with cross-module linking. ([source](https://github.com/realm/jazzy#readme))
- [Multi-Module API Documenters](https://awesome-repositories.com/f/development-tools-productivity/multi-module-api-documenters.md) — Aggregates documentation from several separate source modules into a single site with cross-module linking.
- [Source Code Documentation Tools](https://awesome-repositories.com/f/development-tools-productivity/source-code-documentation-tools.md) — Analyzes project roots and compiled modules to automate the creation of technical API references.
- [Documentation Build Pipelines](https://awesome-repositories.com/f/development-tools-productivity/documentation-build-pipelines.md) — Provides a build pipeline that uses JSON or YAML configuration files to control the documentation generation process.
- [Source Code Linking](https://awesome-repositories.com/f/development-tools-productivity/source-code-linking.md) — Links documentation to source code hosted on external git platforms with precise line-range references. ([source](https://github.com/realm/jazzy/blob/master/CHANGELOG.md))

### Part of an Awesome List

- [Documentation Coverage Analysis](https://awesome-repositories.com/f/awesome-lists/devtools/code-coverage/documentation-coverage-analysis.md) — Tracks the percentage of documented symbols to analyze documentation gaps and generate coverage badges. ([source](https://github.com/realm/jazzy/blob/master/CHANGELOG.md))
- [API Reference Generators](https://awesome-repositories.com/f/awesome-lists/devtools/templating-and-documentation/api-reference-generators.md) — Transforms machine-readable API definitions into formatted technical reference manuals and Dash-compatible docsets.
- [Documentation Tools](https://awesome-repositories.com/f/awesome-lists/devtools/documentation-tools.md) — Tool for generating soulful documentation.
- [Xcode Plugins](https://awesome-repositories.com/f/awesome-lists/devtools/xcode-plugins.md) — Generates documentation from code comments.

### Education & Learning Resources

- [Integration Guides](https://awesome-repositories.com/f/education-learning-resources/integration-guides.md) — Includes external markdown files as dedicated guide pages integrated directly into the navigation sidebar. ([source](https://github.com/realm/jazzy#readme))
- [Technical Guides](https://awesome-repositories.com/f/education-learning-resources/technical-guides.md) — Integrates structured technical guides and LaTeX mathematical equations to complement generated API references.