aboutsummaryrefslogtreecommitdiff
path: root/dokka-subprojects/README.md
blob: 855a00830390b8e982f4a9226e63773c696f1667 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Dokka subprojects

## Dokka plugins

| Plugin project                                               | Description                                                                                   |
|--------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
| [plugin-all-modules-page](plugin-all-modules-page)           | Provides the ability to generate multi-module documentation.                                  |
| [plugin-android-documentation](plugin-android-documentation) | Improves documentation experience on the Android platform.                                    |
| [plugin-base](plugin-base)                                   | Includes base Dokka features and extensions, along with the built-in HTML format              |
| [plugin-gfm](plugin-gfm)                                     | Provides the ability to generate documentation in `GitHub Flavoured Markdown` format.         |
| [plugin-javadoc](plugin-javadoc)                             | Provides the ability to generate documentation in Javadoc format.                             |
| [plugin-jekyll](plugin-jekyll)                               | Provides the ability to generate documentation in `Jekyll Flavoured Markdown` format.         |
| [plugin-kotlin-as-java](plugin-kotlin-as-java)               | Renders all Kotlin signatures as Java signatures.                                             |
| [plugin-mathjax](plugin-mathjax)                             | Allows rendering mathematics in the web pages.                                                |
| [plugin-templating](plugin-templating)                       | An internal Dokka plugin that handles HTML template processing.                               |
| [plugin-versioning](plugin-versioning)                       | Provides the ability to host documentation for multiple versions of your library/application. |