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 上找到源代码。