realm/jazzy

これは何？

主な機能

• 01ClangとSourceKitのASTおよびドキュメントコメントを読み取ってドキュメントを生成します。
• 02XcodeおよびSwift Package Managerのプロジェクトに加え、Objective-Cにも対応しています。
• 03シンボルグラフを使ってコンパイル済みのSwiftモジュールからドキュメントを生成できます。
• 04複数のモジュールを、モジュール間リンク付きの1つのサイトにまとめられます。
• 05KaTeXでLaTeX数式をレンダリングし、Markdownガイドも含められます。
• 06Dash docsetを生成でき、3種類の組み込みテーマを利用できます。

ユースケース

• SwiftのフレームワークやSDKのAPIリファレンスを公開する。
• アンブレラヘッダーを備えたObjective-Cライブラリのドキュメントを作成する。
• アプリとその拡張機能のドキュメントを1つのサイトにまとめる。
• オフラインで参照できるDash docset形式のドキュメントを作成する。

クイックスタート

1. 1

   RubyGemsでjazzyをインストールします

   [sudo] gem install jazzy
2. 2

   Swiftプロジェクトのルートからjazzyを実行します

   jazzy

使う前に知っておきたいこと

• !JazzyはmacOSでの実行を想定しています。Linuxで使用するには、READMEにある追加のヒントが必要です。

収録されている特集

トピック

よくある質問

jazzy とは？

SwiftおよびObjective-Cプロジェクト向けに、Apple風のHTML APIドキュメントを生成するコマンドラインツール。 jazzyは、SwiftおよびObjective-CのコードからAPIリファレンスドキュメントを生成します。ソースファイルを直接解析するのではなく、ClangとSourceKitを使ってコードのASTとドキュメントコメントを読み取り、正確な出力を目指します。生成されるページは、Apple公式のリファレンスドキュメントと同じスタイルです。

jazzy は無料で使えますか？ライセンスは？

jazzy は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

jazzy は今もメンテナンスされていますか？

半年以内に更新あり。jazzy の最終コミットは 2026年10月1日 です。

jazzy は何に使えますか？

SwiftのフレームワークやSDKのAPIリファレンスを公開する。 アンブレラヘッダーを備えたObjective-Cライブラリのドキュメントを作成する。 アプリとその拡張機能のドキュメントを1つのサイトにまとめる。 オフラインで参照できるDash docset形式のドキュメントを作成する。

jazzy のインストール方法は？

RubyGemsでjazzyをインストールします: [sudo] gem install jazzy Swiftプロジェクトのルートからjazzyを実行します: jazzy

jazzy はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/realm/jazzy