Skip to content
CAI
Software that uses CAICheck a score

realm/jazzy

49.2

Weak · 14 November 2026

5.1k

lines of production code

Ruby

with JavaScript

8

measurements over time

CAI band scale
CAI trend line
CAI lens gauges

What this system is

Jazzy is a documentation generator for Swift and Objective-C codebases that parses source code via SymbolGraph and SourceKit to produce static HTML documentation. It supports multiple visual themes with features like client-side search, syntax highlighting, and mathematical rendering, while allowing configuration via files or environment variables. The system integrates with external source hosts like GitHub, GitLab, and Bitbucket to provide direct links to source code and handles access control filtering to manage symbol visibility.

How it got here

2014 — modular architecture and tooling setup

10 changes.

The project established its foundational structure by refactoring the monolithic core into modular components and standardizing CLI configuration via Bundler. This period also introduced comprehensive development tooling, including linting, CI checks, and integration testing, while modernizing dependencies and removing legacy documentation assets.

2015 — Apple and Fullwidth theme modernization

7 changes.

This period focused on a comprehensive overhaul of the Apple and Fullwidth documentation themes, introducing SCSS-based styling, syntax highlighting, and client-side search powered by Lunr.js. The updates also added support for mathematical rendering via KaTeX, deprecation callouts, and external source-host linking, while ensuring test isolation through a new pre-flight helper.

2016–2020 — Swift SymbolGraph support and theme overhaul

5 changes.

Jazzy introduced a new Swift SymbolGraph importer to accurately reconstruct API documentation structures, including generic constraints and protocol conformations. The Jony documentation theme was completely rewritten to support KaTeX math rendering, improved hash-based navigation, and direct source code links for GitLab and Bitbucket.

Features

Added support for GitLab and Bitbucket source hosts and upgraded KaTeX to 0.16.25

The documentation generator now supports GitLab and Bitbucket as source hosts, adding the respective brand icons to the UI. Additionally, the KaTeX library used for rendering math expressions in Markdown has been updated to version 0.16.25, bringing new font assets and styling improvements to mathematical content.

lib/jazzy/extensions · high confidence

Apple theme adds client-side search and math rendering

The Apple theme now includes a client-side search feature powered by Lunr.js, allowing users to search documentation directly in the browser without a backend search service. Additionally, the theme supports rendering mathematical expressions using KaTeX, enabling proper display of math in markdown content. The theme also updates jQuery to version 3.7.1 and includes logic to automatically expand documentation items when linked via hash fragments.

lib/jazzy/themes/apple/assets/js · high confidence

Initial project scaffolding and tooling setup

The repository is initialized with core project files including a MIT license, a comprehensive CHANGELOG, and a CONTRIBUTING guide that defines the workflow for updates and integration specs. Development tooling is established via a Rakefile (providing tasks for specs, RuboCop linting, and SourceKitten vendoring), a Dangerfile for CI checks, and a .rubocop.yml configuration. The project structure includes submodules for the SourceKitten dependency and integration specs, alongside documentation for Objective-C support and a README detailing usage.

(repo-wide) · high confidence

New Swift SymbolGraph importer for accurate documentation generation

Jazzy now includes a new SymbolGraph importer (lib/jazzy/symbol\_graph) that parses Swift's symbol graph JSON to reconstruct the API documentation structure. This new component introduces classes for handling symbols, relationships, constraints, and extensions, enabling more accurate representation of Swift features such as generic constraints, protocol conformances, default implementations, and extensions with complex where clauses. The importer rebuilds the AST structure from the flat symbol graph data and converts it to SourceKit format, improving documentation quality for modern Swift codebases.

_lib/jazzy/symbol\graph · high confidence

Removals

Removal of legacy iOS documentation assets

The legacy CSS stylesheet (style-1.1.15.css), JavaScript logic (devpubs-1.1.15.js), and SVG play button image (playbutton.svg) used for rendering iOS documentation have been removed. This cleanup eliminates the specific client-side rendering, navigation, and media playback logic previously required for these older documentation formats.

lib/assets · high confidence

Removed legacy Jazzy documentation assets

Deleted the generated documentation files for the jazzy-docs area, including the CSS stylesheet (style-1.1.15.css), the JavaScript logic (devpubs-1.1.15.js), the play button image (playbutton.svg), and the HTML reference pages (RLMAccessor.html, RLMArray.html).

jazzy-docs · high confidence

Architecture

Refactored Jazzy core into modular components

The main Jazzy library has been restructured to replace the monolithic Jazzy class with a modular architecture. The previous implementation, which contained hardcoded documentation examples and direct file handling logic, has been removed. It is now replaced by explicit requires for the new Jazzy::Config and Jazzy::DocBuilder modules, and the default external encoding is set to UTF-8. This change prepares the codebase for configuration-driven behavior and cleaner separation of concerns.

lib · high confidence

Behavioural changes

2 commits (0 fixes) modifying images

A change to existing behaviour in images — 2 commits, 5 files.

images · medium confidence · unverified

Apple theme receives comprehensive CSS overhaul and syntax highlighting support

The Apple theme's visual presentation has been updated with a new, structured SCSS architecture. A dedicated highlight.css.scss file has been added to provide syntax highlighting for code blocks, ensuring code snippets are displayed with appropriate colors and styles. The main jazzy.css.scss has been rewritten to use SCSS variables for consistent theming, introducing a CSS reset, updated typography, and specific styling for new features such as markdown footnotes (via .footnote-ref and .footnote-def classes). This change modernizes the theme's codebase and improves the readability of generated documentation.

lib/jazzy/themes/apple/assets/css, lib/jazzy/themes/jony/assets/css · high confidence

Apple theme templates rewritten with search, deprecation, and source-host support

The Apple documentation theme templates have been completely rewritten to enhance the user experience. The new layout includes a built-in search bar (powered by Lunr.js) in the header, which can be disabled via the \disable\_search\ flag. Deprecated or unavailable APIs are now displayed using distinct, styled callouts via a dedicated \deprecation.mustache\ partial. The templates also support rendering declarations for other languages (e.g., Swift for Objective-C) and include links to view source code on external hosts like GitLab or Bitbucket via \source\_host\_item\_url\. Additionally, the footer now includes \rel="noopener"\ on external links for security, and the structure supports KaTeX for math rendering and custom head injection.

lib/jazzy/themes/apple/templates · high confidence

The fullwidth documentation theme now displays distinct visual callouts for deprecated or unavailable API items, improving visibility of discouraged usage. Additionally, the generated documentation pages include links to view source code on external hosts (such as GitHub, GitLab, or Bitbucket) when configured, and the footer links now include rel="noopener" for security.

lib/jazzy/themes/fullwidth/templates · high confidence

Fullwidth theme receives new syntax highlighting and style variables

The fullwidth theme now includes a dedicated syntax highlighting stylesheet (highlight.css.scss) to properly color code blocks, alongside a refactored main stylesheet (jazzy.css.scss) that introduces SCSS variables for consistent theming of colors, fonts, and layout dimensions.

lib/jazzy/themes/fullwidth/assets/css · high confidence

Improved documentation coverage reporting and symbol lookup

Jazzy now provides more detailed statistics in its output, explicitly reporting the number of symbols skipped due to access control level (ACL) or Swift SPI declarations, and allowing users to adjust these filters via \--min-acl\ and \--include-spi-declarations\. Additionally, a new \DocIndex\ class enhances name resolution for custom categories and autolinks, supporting fully qualified names, regex-based lookups, and context-aware symbol resolution that mimics Swift's scoping rules.

jazzy · high confidence

Introduce dedicated Type class for declaration kind handling

A new \Jazzy::SourceDeclaration::Type\ class has been added to centralize the logic for identifying and categorizing source declaration kinds. This change replaces scattered kind-checking logic with a structured approach, providing methods to determine if a declaration is a Swift or Objective-C type, extension, protocol, or specific marker (like MARK/TODO/FIXME), and to map these kinds to their corresponding documentation types (e.g., Dash types, URL names). This refactoring improves the maintainability and accuracy of how different code constructs are processed and documented.

_lib/jazzy/source\declaration · high confidence

Jazzy 0.15.5 release with Swift 6.1 and Ruby 3.1 support

This release updates Jazzy to version 0.15.5, adding support for Swift 6.1 and moving the CI environment to Ruby 3.1. The update includes various fixes and improvements to the documentation generation process, such as better handling of Swift concurrency, symbolgraph integration, and Objective-C declarations. It also addresses several issues related to autolinking, custom categories, and documentation coverage reporting.

lib/jazzy · high confidence

Jony theme now supports KaTeX math rendering and improved hash-based navigation

The Jony theme's JavaScript assets have been updated to include jQuery 3.7.1 and a new jazzy.js module that enables KaTeX rendering for mathematical expressions in documentation. Additionally, the theme now automatically expands documentation items when accessed via hash links (e.g., \#//apple\_ref/...), improving navigation for users jumping to specific sections.

lib/jazzy/themes/jony/assets/js · high confidence

The Jony documentation theme has been completely rewritten to improve clarity and usability. Deprecated or unavailable API items now display distinct, styled callouts (aside blocks) to clearly signal their status. The layout includes new links to view source code on external hosts (such as GitHub, GitLab, or Bitbucket) directly from documentation pages. Additionally, the theme now supports KaTeX for rendering mathematical expressions in markdown and includes security improvements by adding \rel="noopener"\ to external links.

lib/jazzy/themes/jony/templates · high confidence

Refactored CLI entry point to use Config and Bundler

The bin/jazzy script has been rewritten to replace the previous inline OptionParser logic with a centralized Jazzy::Config system, allowing users to manage options via configuration files or environment variables rather than only command-line flags. The script now automatically handles dependency loading via Bundler (unless JAZZY\_NO\_BUNDLER is set) and delegates execution to Jazzy::DocBuilder.build, simplifying the executable and standardizing how configuration is parsed and applied.

bin · high confidence

Test coverage

Added integration test suite for Jazzy documentation generation; Added pre-flight test helper to reset configuration state.

Dependencies

Fullwidth theme JavaScript updated to jQuery 3.7.1 with new search and math rendering

The fullwidth theme's client-side assets have been refreshed: jQuery has been upgraded to version 3.7.1, and the search functionality now uses the Typeahead library (v1.2.1) backed by Lunr for indexing document names and abstracts. Additionally, the theme now supports rendering mathematical expressions in markdown using KaTeX, and includes logic to automatically expand documentation items when linked via hash anchors.

lib/jazzy/themes/fullwidth/assets/js · high confidence

Jazzy 0.15.5 dependency update and Ruby infrastructure modernization

This change updates the Jazzy documentation generator to version 0.15.5, introducing a comprehensive set of dependency upgrades and infrastructure improvements. The Ruby environment is modernized by requiring Ruby 2.6.3 or higher and updating core dependencies such as CocoaPods to \~\> 1.5, Activesupport to \>= 5.0, and Rouge to \>= 2.0.6. Development tooling is also refreshed, with RuboCop bumped to \~\> 1.18, Danger to 9.6.1, and the introduction of CLIntegracon for integration testing. Additionally, the JavaScript theme dependencies are updated to include jQuery 3.7.1, KaTeX 0.16.25, and Lunr 2.3.9, ensuring better compatibility and performance for generated documentation.

(dependencies) · high confidence

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

How this codebase got here

Score

  • CAI 50 → 49 (-0.8)
  • Rubric changed (rubric-2026.10.5 → rubric-2026.11.4) — scores are not directly comparable.

Lenses

  • Code Health 55 → 51 (-3.5)
  • Architecture 96 → 96 (-0.2)
  • Maturity 57 → 58 (+0.7)
  • Readiness 65 → 65 (-0.1)
  • Security 72 → 53 (-18.8)
  • Accessibility 38 → 42 (+3.4)

Resolved (1)

  • Off-boarding risk: anonymized user #1

New (6)

  • High CVE: [GHSA redacted] (Gemfile.lock)
  • Medium CVE: [GHSA redacted] (Gemfile.lock)
  • Medium CVE: [GHSA redacted] (Gemfile.lock)
  • No ADRs found (jazzy.gemspec)
  • Off-boarding risk: anonymized user #1
  • Outdated: danger

Architecture

  • Unchanged — 0 containers · 1 contexts · 0 edges

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

Survey your own repository

realm/jazzy was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.

About this page

  • The score is its most recent published measurement, taken on 14 November 2026 at a pinned commit. It is not a live figure and does not change until the project is measured again.
  • Measured at commit 7b522448c9ff94c64df2d692fa65f1f7f6262ecf — the exact code this score is about.
  • Scored under rubric-2026.11.4 — the same rubric and the same method as every other entry in this index.
  • Measured by Canine Code Analyzer (cca.canine.dev) using cca measure-2026.11.65+preprod-36d4cd83012f.