blob: 15ad9071618d329012239fbd475c3185ee1cc9af (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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.
|
