diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
| commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
| tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /plugins/gfm | |
| parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
| download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip | |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'plugins/gfm')
| -rw-r--r-- | plugins/gfm/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
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). |