# Kotlin/dokka

API documentation engine for Kotlin

Repository: https://github.com/Kotlin/dokka
Canonical: https://ross.abutalabs.com/products/dokka
Homepage: https://kotl.in/dokka
Language: Kotlin
License: Apache-2.0
License Family: permissive
Topics: api-reference, documentation, dokka, kotlin
Last push: 2026-08-24T14:57:56+00:00

## Health v2 (maintenance only)
Score: 80/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 44, longevity 100
- inputs: {"age_days": 4435, "days_push": 9, "days_rel": 160, "gap_med": 232.0, "n_releases_24m": 3}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3805, forks 497 (observed 2026-08-28T04:08:20.240534+00:00)

## What it is
Dokka is an API documentation engine for Kotlin that understands KDoc and Javadoc comments in mixed-language projects. It generates documentation in HTML, Markdown (GFM/Jekyll), and Javadoc-style formats via Gradle, Maven, or CLI runners, and is highly extensible through plugins.

## Use cases
- generate API reference docs for a Kotlin library
- produce javadoc.jar for publishing to Maven Central
- document a mixed Kotlin and Java codebase
- generate Markdown documentation for a Kotlin multiplatform project
- host Kotlin API docs on GitHub Pages
- customize documentation rendering with a Dokka plugin

## When to choose
- you maintain a Kotlin or Kotlin/Java library and need API reference documentation
- you need javadoc.jar artifacts for Maven publishing
- you want HTML or Markdown docs generated from KDoc comments
- you need multiplatform or multi-module documentation support

## When to avoid
- your project is pure Java and standard Javadoc suffices
- you need hand-written guides rather than generated API references
- you need Javadoc format for multi-project or multiplatform builds (unsupported)

## Facets
- artifact type: library
- maturity: active
- function: documentation, api-documentation, build-tool, cli, plugin-system
- domain: documentation, developer-tools, programming-languages, apis
- platform: jvm, cli, cross-platform
- tags: kdoc, javadoc, kotlin, gradle-plugin, maven-plugin, static-docs, jetbrains, gradle, maven

## Member repositories
- Kotlin/dokka (main) score 80

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:20.240534+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:26:46.837383+00:00, confidence not recorded.
  - readme: https://github.com/Kotlin/dokka (fetched 2026-08-28T04:08:20.240534+00:00, sha e1bd2c5d08b9)
  - homepage: https://kotl.in/dokka (fetched 2026-08-29T09:21:43.492598+00:00, sha bb61418400ce)
  - site_page: https://kotlinlang.org/docs/kotlin-doc.html (fetched 2026-08-29T09:21:43.501965+00:00, sha 8b11432bcd3e)
  - site_page: https://kotlinlang.org/docs/dokka-html.html (fetched 2026-08-29T09:21:43.504260+00:00, sha 2e4da0585f0b)
  - site_page: https://kotlinlang.org/docs/dokka-javadoc.html (fetched 2026-08-29T09:21:43.506389+00:00, sha 7a851041ae61)
  - site_page: https://kotlinlang.org/docs/dokka-gradle.html (fetched 2026-08-29T09:21:43.508308+00:00, sha c36c5afb06a2)
  - site_page: https://kotlinlang.org/docs/dokka-maven.html (fetched 2026-08-29T09:21:43.510389+00:00, sha 0ef9cd1239b3)
  - site_page: https://kotlinlang.org/docs/dokka-cli.html (fetched 2026-08-29T09:21:43.512585+00:00, sha d61495b610af)
  - site_page: https://kotlinlang.org/docs/dokka-plugins.html (fetched 2026-08-29T09:21:43.514755+00:00, sha 370eb88ca4b2)
  - site_page: https://kotlinlang.org/docs/dokka-get-started.html (fetched 2026-08-29T09:21:43.516639+00:00, sha ce929f08a99f)
- Data as of 2026-08-30T08:39:29.467469+00:00.
