Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 928 Bytes

File metadata and controls

17 lines (12 loc) · 928 Bytes

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

This plugin is at its early stages, so you may experience issues and encounter bugs. Feel free to report any errors you see.