diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
| commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
| tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /plugins/README.md | |
| parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
| download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip | |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'plugins/README.md')
| -rw-r--r-- | plugins/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 00000000..00e0396f --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,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. | |