aboutsummaryrefslogtreecommitdiff
path: root/plugins/jekyll/README.md
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/jekyll/README.md
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/jekyll/README.md')
-rw-r--r--plugins/jekyll/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/jekyll/README.md b/plugins/jekyll/README.md
new file mode 100644
index 00000000..15ad9071
--- /dev/null
+++ b/plugins/jekyll/README.md
@@ -0,0 +1,17 @@
+# Jekyll plugin
+
+The Jekyll plugin adds the ability to generate documentation in `Jekyll Flavoured Markdown` format. It supports both
+multi-module and multiplatform projects.
+
+The Jekyll plugin is shipped together with the Dokka Gradle Plugin, so you can start using it
+right away with one of the following tasks:
+
+* `dokkaJekyll` - generate documentation for a single-project build or one specific module.
+* `dokkaJekyllMultiModule` - generate documentation for a multi-module project, assemble it together and
+ generate navigation page/menu for all the modules.
+
+To use it with Maven or CLI runners, you have to add it as a dependency. You can find it on
+[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/jekyll-plugin)
+
+**This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to
+[report](https://github.com/Kotlin/dokka/issues/new/choose) any errors you see.