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 上找到原始碼。