From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Thu, 19 Jan 2023 04:10:57 +0100 Subject: Revise README documentation for examples and plugins (#2736) --- plugins/gfm/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 plugins/gfm/README.md (limited to 'plugins/gfm') diff --git a/plugins/gfm/README.md b/plugins/gfm/README.md new file mode 100644 index 00000000..1d65c0f0 --- /dev/null +++ b/plugins/gfm/README.md @@ -0,0 +1,17 @@ +# GFM plugin + +The GFM plugin adds the ability to generate documentation in `GitHub Flavoured Markdown` format. It supports both +multi-module and multiplatform projects. + +The GFM plugin is shipped together with the Dokka Gradle Plugin, so you can start using it +right away with one of the following tasks: + +* `dokkaGfm` - generate documentation for a single-project build or one specific module. +* `dokkaGfmMultiModule` - 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 the CLI runner, you have to add it as a dependency. You can find it on +[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin) + +GFM plugin comes built in with the Dokka Gradle plugin. You can also find it on +[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/gfm-plugin). -- cgit