# realm/jazzy

Soulful docs for Swift & Objective-C

Repository: https://github.com/realm/jazzy
Canonical: https://ross.abutalabs.com/products/jazzy
Homepage: https://realm.io
Language: Ruby
License: MIT
License Family: permissive
Topics: swift, sourcekit, sourcekitten, ruby, xcode
Last push: 2026-06-30T09:54:55+00:00

## Health v2 (maintenance only)
Score: 68/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 90, release rhythm 21, longevity 100
- inputs: {"age_days": 4471, "days_push": 64, "days_rel": 317, "gap_med": 197.0, "n_releases_24m": 3}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 7379, forks 414 (observed 2026-08-28T04:09:58.612296+00:00)

## What it is
Jazzy is a Ruby-based command-line tool that generates API documentation for Swift and Objective-C projects. It uses Clang and SourceKit AST representations to produce documentation styled like Apple's official reference docs.

## Use cases
- generate documentation for a swift framework
- create apple-style api reference docs for objective-c
- document a swift package manager module
- generate docs from a compiled swift module symbol graph
- document multiple modules in one project
- produce html documentation from xcode project source comments

## When to choose
- you maintain a Swift or Objective-C library and want polished HTML reference docs
- you want docs that match Apple's official documentation look and feel
- your project builds with Xcode or Swift Package Manager on macOS

## When to avoid
- you need documentation for languages other than Swift or Objective-C
- your CI runs on Linux and you can't work around jazzy's macOS-first design
- you prefer Swift-DocC for modern Swift projects

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, parser, static-site-generator
- domain: documentation, developer-tools, apple-ecosystem
- platform: cli
- tags: swift-docs, objective-c-docs, sourcekit, clang, ruby-gem, api-reference, macos, swift

## Member repositories
- realm/jazzy (main) score 68

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:58.612296+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:38:22.320258+00:00, confidence not recorded.
  - readme: https://github.com/realm/jazzy (fetched 2026-08-28T04:09:58.612296+00:00, sha 60a8b93d7647)
  - homepage: https://realm.io (fetched 2026-08-29T08:33:36.734566+00:00, sha 7fe20d311e00)
- Data as of 2026-08-30T08:39:29.467469+00:00.