마크다운

DANGER

마크다운 출력 형식은 아직 알파 버전이므로, 사용 시 버그가 발생하거나 마이그레이션 문제가 발생할 수 있습니다.

사용에 대한 책임은 전적으로 사용자에게 있습니다.

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

이러한 형식은 출력을 문서 웹사이트에 바로 삽입할 수 있어 문서를 호스팅하는 데 더 많은 자유를 제공합니다. 예를 들어, OkHttp의 API 참조 페이지를 확인해 보세요.

마크다운 출력 형식은 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과 호환되는 마크다운 형식으로 문서를 생성합니다.

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에서 확인할 수 있습니다.