aboutsummaryrefslogtreecommitdiff
path: root/plugins/README.md
blob: 00e0396f45a27d729981fdbc4b52c5832fb70545 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Dokka plugins

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