Markdown

DANGER

Markdown出力フォーマットはまだAlpha段階であるため、使用中にバグや移行に関する問題が発生する可能性があります。

自己責任でご使用ください。

Dokkaは、GitHub Flavored および Jekyll と互換性のあるMarkdownでドキュメントを生成できます。

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

Markdown出力フォーマットは、Dokkaチームが保守するDokkaプラグインとして実装されており、オープンソースです。

GFM

GFM出力フォーマットは、GitHub Flavored Markdownでドキュメントを生成します。

Maven

<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>

CLI

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

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

Jekyll

Jekyll出力フォーマットは、Jekyllと互換性のあるMarkdownでドキュメントを生成します。

Maven

<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>

CLI

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" \
     ...

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