Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kotlin/dokka
API documentation engine for Kotlin
https://github.com/Kotlin/dokka
api-reference documentation dokka kotlin
Last synced: about 2 months ago
JSON representation
API documentation engine for Kotlin
- Host: GitHub
- URL: https://github.com/Kotlin/dokka
- Owner: Kotlin
- License: apache-2.0
- Created: 2014-07-12T09:15:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T14:59:54.000Z (8 months ago)
- Last Synced: 2024-04-12T16:55:36.982Z (8 months ago)
- Topics: api-reference, documentation, dokka, kotlin
- Language: Kotlin
- Homepage: https://kotl.in/dokka
- Size: 451 MB
- Stars: 3,243
- Watchers: 65
- Forks: 390
- Open Issues: 596
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-kotlin - dokka - Documentation Engine for Kotlin (Libraries)
- awesome-kotlin-multiplatform - dokka (official) - Documentation Engine for Kotlin. (Libraries / Docs)
- awesome-documentation - Dokka - An API documentation engine for Kotlin. (Documentation Types / Code Documentation)
README
# Dokka
[](https://kotlinlang.org/docs/components-stability.html)
[](https://github.com/JetBrains#jetbrains-on-github)
[](https://search.maven.org/artifact/org.jetbrains.dokka/org.jetbrains.dokka.gradle.plugin)
[](https://plugins.gradle.org/plugin/org.jetbrains.dokka)
[](LICENSE.txt)
[](https://ge.jetbrains.com/scans?search.rootProjectNames=dokka)
Dokka is an API documentation engine for Kotlin.
Just like Kotlin itself, Dokka supports mixed-language projects. It understands Kotlin's
[KDoc comments](https://kotlinlang.org/docs/kotlin-doc.html#kdoc-syntax) and Java's
[Javadoc comments](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html).
Dokka can generate documentation in multiple formats, including its own modern [HTML format](#html),
multiple flavors of [Markdown](#markdown), and Java's [Javadoc HTML](#javadoc).
Some libraries that use Dokka for their API reference documentation:
* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/)
* [Bitmovin](https://cdn.bitmovin.com/player/android/3/docs/index.html)
* [Hexagon](https://hexagonkt.com/api/index.html)
* [Ktor](https://api.ktor.io/)
* [OkHttp](https://square.github.io/okhttp/5.x/okhttp/okhttp3/)
* [Gradle](https://docs.gradle.org/current/kotlin-dsl/index.html)
You can run Dokka using [Gradle](https://kotlinlang.org/docs/dokka-gradle.html),
[Maven](https://kotlinlang.org/docs/dokka-maven.html) or from the [command line](https://kotlinlang.org/docs/dokka-cli.html).
It is also [highly pluggable](https://kotlinlang.org/docs/dokka-plugins.html).
## Documentation
Comprehensive documentation for Dokka is available on [kotlinlang.org](https://kotlinlang.org/docs/dokka-introduction.html)
## Get started with Dokka
### Gradle
Kotlin DSL
Apply the Gradle plugin for Dokka in the root build script of your project:
```kotlin
plugins {
id("org.jetbrains.dokka") version "1.9.20"
}
```
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need
to apply the Gradle plugin for Dokka within subprojects as well:
```kotlin
subprojects {
apply(plugin = "org.jetbrains.dokka")
}
```
Groovy DSL
Apply Gradle plugin for Dokka in the root project:
```groovy
plugins {
id 'org.jetbrains.dokka' version '1.9.20'
}
```
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need
to apply the Gradle plugin for Dokka within subprojects as well:
```groovy
subprojects {
apply plugin: 'org.jetbrains.dokka'
}
```
To generate documentation, run the following Gradle tasks:
* `dokkaHtml` for single-project builds
* `dokkaHtmlMultiModule` for multi-project builds
By default, the output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule` respectively.
To learn more about the Gradle plugin for Dokka, see [documentation for Gradle](https://kotlinlang.org/docs/dokka-gradle.html).
### Maven
Add the Dokka Maven plugin to the `plugins` section of your POM file:
```xml
org.jetbrains.dokka
dokka-maven-plugin
1.9.20
pre-site
dokka
```
To generate documentation, run the `dokka:dokka` goal.
By default, the output directory is set to `target/dokka`.
To learn more about using Dokka with Maven, see [documentation for Maven](https://kotlinlang.org/docs/dokka-maven.html).
### CLI
It is possible to run Dokka from the command line without having to use any of the build tools, but it's more
difficult to set up and for that reason it is not covered in this section.
Please consult [documentation for the command line runner](https://kotlinlang.org/docs/dokka-cli.html)
to learn how to use it.
### Android
In addition to applying and configuring Dokka, you can apply Dokka's
[Android documentation plugin](plugins/android-documentation), which aims to improve documentation experience on the
Android platform:
Gradle Kotlin DSL
```kotlin
dependencies {
dokkaPlugin("org.jetbrains.dokka:android-documentation-plugin:1.9.20")
}
```
Gradle Groovy DSL
```groovy
dependencies {
dokkaPlugin 'org.jetbrains.dokka:android-documentation-plugin:1.9.20'
}
```
Maven
```xml
org.jetbrains.dokka
dokka-maven-plugin
...
org.jetbrains.dokka
android-documentation-plugin
1.9.20
```
## Output formats
### HTML
HTML is Dokka's default and recommended output format. You can see an example of the output by browsing documentation
for [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/).
HTML format is configurable and, among other things, allows you to modify stylesheets, add custom image assets, change
footer message and revamp the structure of the generated HTML pages through templates.
For more details and examples, see [documentation for HTML format](https://kotlinlang.org/docs/dokka-html.html).
### Markdown
Dokka is able to generate documentation in GitHub Flavored and Jekyll compatible Markdown. However, both of these
formats are still in Alpha, so you might encounter bugs and migration issues.
For more details and examples, see [documentation for Markdown formats](https://kotlinlang.org/docs/dokka-markdown.html).
### Javadoc
Dokka's Javadoc output format is a lookalike of Java's
[Javadoc HTML format](https://docs.oracle.com/en/java/javase/19/docs/api/index.html). This format is still in Alpha,
so you might encounter bugs and migration issues.
Javadoc format tries to visually mimic HTML pages generated by the Javadoc tool, but it's not a direct implementation
or an exact copy. In addition, all Kotlin signatures are translated to Java signatures.
For more details and examples, see [documentation for Javadoc format](https://kotlinlang.org/docs/dokka-javadoc.html).
## Dokka plugins
Dokka was built from the ground up to be easily extensible and highly customizable, which allows the community to
implement plugins for missing or very specific features that are not provided out of the box.
Learn more about Dokka plugins and their configuration in [Dokka plugins](https://kotlinlang.org/docs/dokka-plugins.html).
If you want to learn how to develop Dokka plugins, see
[Developer guides](https://kotlin.github.io/dokka/1.9.20/developer_guide/introduction/).
## Community
Dokka has a dedicated `#dokka` channel in [Kotlin Community Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up)
where you can chat about Dokka, its plugins and how to develop them, as well as get in touch with maintainers.
## Building and Contributing
See [Contributing Guidelines](CONTRIBUTING.md)