aboutsummaryrefslogtreecommitdiff
path: root/plugins/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/README.md')
-rw-r--r--plugins/README.md14
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. |