Markdown

Markdown 输出格式仍处于 Alpha 阶段，因此您在使用时可能会发现错误并遇到迁移问题。 使用它们需自担风险。

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>

配置完成后，运行 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>

配置完成后，运行 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 上找到源代码。