diff options
Diffstat (limited to 'plugins/jekyll/README.md')
| -rw-r--r-- | plugins/jekyll/README.md | 17 |
1 files changed, 0 insertions, 17 deletions
diff --git a/plugins/jekyll/README.md b/plugins/jekyll/README.md deleted file mode 100644 index 15ad9071..00000000 --- a/plugins/jekyll/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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. |