1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
[//]: # (title: Markdown)
> The Markdown output formats are still in Alpha, so you may find bugs and experience migration issues when using them.
> **You use them at your own risk.**
>
{type="warning"}
Dokka is able to generate documentation in [GitHub Flavored](#gfm) and [Jekyll](#jekyll) compatible Markdown.
These formats give you more freedom in terms of hosting documentation as the output can be embedded right into your
documentation website. For example, see [OkHttp's API reference](https://square.github.io/okhttp/4.x/okhttp/okhttp3/)
pages.
Markdown output formats are implemented as [Dokka plugins](dokka-plugins.md), maintained by the Dokka team, and
they are open source.
## GFM
The GFM output format generates documentation in [GitHub Flavored Markdown](https://github.github.com/gfm/).
<tabs group="build-script">
<tab title="Gradle" group-key="kotlin">
The [Gradle plugin for Dokka](dokka-gradle.md) comes with the GFM output format included. You can use the following tasks with it:
| **Task** | **Description** |
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dokkaGfm` | Generates GFM documentation for a single project. |
| `dokkaGfmMultiModule` | A [`MultiModule`](dokka-gradle.md#multi-project-builds) task created only for parent projects in multi-project builds. It generates documentation for subprojects and collects all outputs in a single place with a common table of contents. |
| `dokkaGfmCollector` | A [`Collector`](dokka-gradle.md#collector-tasks) task created only for parent projects in multi-project builds. It calls `dokkaGfm` for every subproject and merges all outputs into a single virtual project. |
</tab>
<tab title="Maven" group-key="groovy">
Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to apply it as a plugin
dependency:
```xml
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
...
<configuration>
<dokkaPlugins>
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>gfm-plugin</artifactId>
<version>%dokkaVersion%</version>
</plugin>
</dokkaPlugins>
</configuration>
</plugin>
```
After configuring this, running the `dokka:dokka` goal produces documentation in GFM format.
For more information, see the Mavin plugin documentation for [Other output formats](dokka-maven.md#other-output-formats).
</tab>
<tab title="CLI" group-key="cli">
Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
[download the JAR file]((https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar))
and pass it to `pluginsClasspath`.
Via [command line options](dokka-cli.md#run-with-command-line-options):
```Bash
java -jar dokka-cli-%dokkaVersion%.jar \
-pluginsClasspath "./dokka-base-%dokkaVersion%.jar;...;./gfm-plugin-%dokkaVersion%.jar" \
...
```
Via [JSON configuration](dokka-cli.md#run-with-json-configuration):
```json
{
...
"pluginsClasspath": [
"./dokka-base-%dokkaVersion%.jar",
"...",
"./gfm-plugin-%dokkaVersion%.jar"
],
...
}
```
For more information, see the CLI runner's documentation for [Other output formats](dokka-cli.md#other-output-formats).
</tab>
</tabs>
You can find the source code [on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-gfm).
## Jekyll
The Jekyll output format generates documentation in [Jekyll](https://jekyllrb.com/) compatible Markdown.
<tabs group="build-script">
<tab title="Gradle" group-key="kotlin">
The [Gradle plugin for Dokka](dokka-gradle.md) comes with the Jekyll output format included. You can use the following tasks with it:
| **Task** | **Description** |
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dokkaJekyll` | Generates Jekyll documentation for a single project. |
| `dokkaJekyllMultiModule` | A [`MultiModule`](dokka-gradle.md#multi-project-builds) task created only for parent projects in multi-project builds. It generates documentation for subprojects and collects all outputs in a single place with a common table of contents. |
| `dokkaJekyllCollector` | A [`Collector`](dokka-gradle.md#collector-tasks) task created only for parent projects in multi-project builds. It calls `dokkaJekyll` for every subproject and merges all outputs into a single virtual project. |
</tab>
<tab title="Maven" group-key="groovy">
Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to apply it as a plugin
dependency:
```xml
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
...
<configuration>
<dokkaPlugins>
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>jekyll-plugin</artifactId>
<version>%dokkaVersion%</version>
</plugin>
</dokkaPlugins>
</configuration>
</plugin>
```
After configuring this, running the `dokka:dokka` goal produces documentation in GFM format.
For more information, see the Maven plugin's documentation for [Other output formats](dokka-maven.md#other-output-formats).
</tab>
<tab title="CLI" group-key="cli">
Since Jekyll format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
[download the JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/jekyll-plugin/%dokkaVersion%/jekyll-plugin-%dokkaVersion%.jar).
This format is also based on [GFM](#gfm) format, so you need to provide it as a dependency as well. Both JARs need to be passed to
`pluginsClasspath`:
Via [command line options](dokka-cli.md#run-with-command-line-options):
```Bash
java -jar dokka-cli-%dokkaVersion%.jar \
-pluginsClasspath "./dokka-base-%dokkaVersion%.jar;...;./gfm-plugin-%dokkaVersion%.jar;./jekyll-plugin-%dokkaVersion%.jar" \
...
```
Via [JSON configuration](dokka-cli.md#run-with-json-configuration):
```json
{
...
"pluginsClasspath": [
"./dokka-base-%dokkaVersion%.jar",
"...",
"./gfm-plugin-%dokkaVersion%.jar",
"./jekyll-plugin-%dokkaVersion%.jar"
],
...
}
```
For more information, see the CLI runner's documentation for [Other output formats](dokka-cli.md#other-output-formats).
</tab>
</tabs>
You can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-jekyll).
|
