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