From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Thu, 19 Jan 2023 04:10:57 +0100 Subject: Revise README documentation for examples and plugins (#2736) --- plugins/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 plugins/README.md (limited to 'plugins/README.md') 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. | -- cgit