Markdown

Dokka может генерировать документацию в совместимых с GitHub Flavored и Jekyll форматах Markdown.

Эти форматы предоставляют больше свободы в размещении документации, так как вывод может быть встроен прямо в ваш веб-сайт документации. Например, см. страницы справки по OkHttp OkHttp's API reference.

Форматы вывода Markdown реализованы в виде плагинов Dokka, поддерживаемых командой Dokka, и являются открытым исходным кодом.

GFM

Формат вывода GFM генерирует документацию в формате GitHub Flavored Markdown.

Плагин Gradle для Dokka поставляется с форматом вывода 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>1.8.20</version>
            </plugin>
        </dokkaPlugins>
    </configuration>
</plugin>

После настройки выполнение цели dokka:dokka создаёт документацию в формате GFM.

Дополнительную информацию см. в документации плагина Maven для других форматов вывода.

Так как формат GFM реализован как плагин Dokka, вам нужно скачать файл JAR и передать его в pluginsClasspath.

Через команды командной строки:

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

Через конфигурацию JSON:

{
  ...
  "pluginsClasspath": [
    "./dokka-base-1.8.20.jar",
    "...",
    "./gfm-plugin-1.8.20.jar"
  ],
  ...
}

Дополнительную информацию см. в документации исполнителя CLI для других форматов вывода.

Исходный код можно найти на GitHub.

Jekyll

Формат вывода Jekyll генерирует документацию в формате, совместимом с Jekyll.

Плагин Gradle для Dokka поставляется с включённым форматом вывода 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>1.8.20</version>
            </plugin>
        </dokkaPlugins>
    </configuration>
</plugin>