마크다운

마크다운 출력 형식은 아직 알파 단계이므로, 사용 중 버그가 발생하거나 마이그레이션 문제가 생길 수 있습니다. 사용에 따른 위험은 전적으로 사용자 부담입니다.

Dokka는 GitHub Flavored 및 Jekyll 호환 마크다운 형식으로 문서를 생성할 수 있습니다.

이러한 형식은 생성된 출력을 문서 웹사이트에 바로 삽입할 수 있으므로 문서 호스팅 측면에서 더 많은 자유를 제공합니다. 예를 들어, OkHttp의 API 참조 페이지를 참조하세요.

마크다운 출력 형식은 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 목표(goal)를 실행하면 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 호환 마크다운으로 문서를 생성합니다.

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 형식에도 기반하므로, 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에서 찾을 수 있습니다.