マークダウン

Markdown の出力形式はまだアルファ版であり、使用する際にバグが見つかったり、移行に関する問題が発生したりする可能性があります。 自己責任でご利用ください。

Dokka は、GitHub Flavored および Jekyll に対応した Markdown でドキュメントを生成できます。

これらの形式は、出力を自身のドキュメントウェブサイトに直接埋め込むことができるため、ドキュメントのホスティングに関してより自由度を提供します。例えば、OkHttp の API リファレンスページを参照してください。

Markdown の出力形式は、Dokka チームによってメンテナンスされているDokka プラグインとして実装されており、オープンソースです。

GFM

GFM 出力形式は、GitHub Flavored Markdown でドキュメントを生成します。

GradleMavenCLI

Dokka 用 Gradle プラグインには GFM 出力形式が付属しています。これとともに以下のタスクを使用できます。

タスク	説明
dokkaGfm	単一プロジェクトの GFM ドキュメントを生成します。
dokkaGfmMultiModule	マルチプロジェクトビルドにおける親プロジェクトのみのために作成されるMultiModuleタスクです。サブプロジェクトのドキュメントを生成し、共通の目次とともにすべての出力を一箇所に収集します。
dokkaGfmCollector	マルチプロジェクトビルドにおける親プロジェクトのみのために作成されるCollectorタスクです。各サブプロジェクトに対してdokkaGfmを呼び出し、すべての出力を単一の仮想プロジェクトにマージします。

GFM 形式はDokka プラグインとして実装されているため、プラグインの依存関係として適用する必要があります。

<plugin>
    <groupId>org.jetbrains.dokka</groupId>
    <artifactId>dokka-maven-plugin</artifactId>
    ...
    <configuration>
        <dokkaPlugins>
            <plugin>
                <groupId>org.jetbrains.dokka</groupId>
                <artifactId>gfm-plugin</artifactId>
                <version>2.0.0</version>
            </plugin>
        </dokkaPlugins>
    </configuration>
</plugin>

これTを設定した後、dokka:dokka ゴールを実行すると GFM 形式でドキュメントが生成されます。

詳細については、Maven プラグインのその他の出力形式のドキュメントを参照してください。

GFM 形式はDokka プラグインとして実装されているため、JAR ファイルをダウンロードし、pluginsClasspath に渡す必要があります。

コマンドラインオプションを介して:

java -jar dokka-cli-2.0.0.jar \
     -pluginsClasspath "./dokka-base-2.0.0.jar;...;./gfm-plugin-2.0.0.jar" \
     ...

JSON 設定を介して:

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.0.0.jar",
    "...",
    "./gfm-plugin-2.0.0.jar"
  ],
  ...
}

詳細については、CLI ランナーのその他の出力形式のドキュメントを参照してください。

ソースコードはGitHub上で確認できます。

Jekyll

Jekyll 出力形式は、Jekyll に対応した Markdown でドキュメントを生成します。

GradleMavenCLI

Dokka 用 Gradle プラグインには Jekyll 出力形式が付属しています。これとともに以下のタスクを使用できます。

タスク	説明
dokkaJekyll	単一プロジェクトの Jekyll ドキュメントを生成します。
dokkaJekyllMultiModule	マルチプロジェクトビルドにおける親プロジェクトのみのために作成されるMultiModuleタスクです。サブプロジェクトのドキュメントを生成し、共通の目次とともにすべての出力を一箇所に収集します。
dokkaJekyllCollector	マルチプロジェクトビルドにおける親プロジェクトのみのために作成されるCollectorタスクです。各サブプロジェクトに対してdokkaJekyllを呼び出し、すべての出力を単一の仮想プロジェクトにマージします。

Jekyll 形式はDokka プラグインとして実装されているため、プラグインの依存関係として適用する必要があります。

<plugin>
    <groupId>org.jetbrains.dokka</groupId>
    <artifactId>dokka-maven-plugin</artifactId>
    ...
    <configuration>
        <dokkaPlugins>
            <plugin>
                <groupId>org.jetbrains.dokka</groupId>
                <artifactId>jekyll-plugin</artifactId>
                <version>2.0.0</version>
            </plugin>
        </dokkaPlugins>
    </configuration>
</plugin>

これTを設定した後、dokka:dokka ゴールを実行すると GFM 形式でドキュメントが生成されます。

詳細については、Maven プラグインのその他の出力形式のドキュメントを参照してください。

Jekyll 形式はDokka プラグインとして実装されているため、JAR ファイルをダウンロードする必要があります。この形式もGFM形式に基づいているため、依存関係として提供する必要があります。両方の JAR を pluginsClasspath に渡す必要があります。

コマンドラインオプションを介して:

java -jar dokka-cli-2.0.0.jar \
     -pluginsClasspath "./dokka-base-2.0.0.jar;...;./gfm-plugin-2.0.0.jar;./jekyll-plugin-2.0.0.jar" \
     ...

JSON 設定を介して:

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.0.0.jar",
    "...",
    "./gfm-plugin-2.0.0.jar",
    "./jekyll-plugin-2.0.0.jar"
  ],
  ...
}

詳細については、CLI ランナーのその他の出力形式のドキュメントを参照してください。

ソースコードはGitHub上で確認できます。