aboutsummaryrefslogtreecommitdiff
path: root/plugins/all-modules-page
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-01-19 04:10:57 +0100
committerGitHub <noreply@github.com>2023-01-19 04:10:57 +0100
commit5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch)
treebb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /plugins/all-modules-page
parent1fa8552994fb292729eca8c0de6a1561380b008c (diff)
downloaddokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2
dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'plugins/all-modules-page')
-rw-r--r--plugins/all-modules-page/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/plugins/all-modules-page/README.md b/plugins/all-modules-page/README.md
new file mode 100644
index 00000000..2524b5eb
--- /dev/null
+++ b/plugins/all-modules-page/README.md
@@ -0,0 +1,7 @@
+# All Modules plugin
+
+Thge All Modules plugin is used for documenting multi-module projects. It creates a common table of contents
+for all submodules and helps resolve cross-module links and resource locations.
+
+You can find the All Modules plugin on
+[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/all-modules-page-plugin).