diff options
| author | Marcin Aman <marcin.aman@gmail.com> | 2020-10-16 16:32:31 +0200 |
|---|---|---|
| committer | Błażej Kardyś <bkardys@virtuslab.com> | 2020-10-19 11:15:04 +0200 |
| commit | 15f348dc13cd7cf05718adce6e3d43e427fba688 (patch) | |
| tree | c965305017d516dc479dde0b19361675ae5b2a96 | |
| parent | c482ed6e688cb9e5105aa0d686613c8ad81905fb (diff) | |
| download | dokka-15f348dc13cd7cf05718adce6e3d43e427fba688.tar.gz dokka-15f348dc13cd7cf05718adce6e3d43e427fba688.tar.bz2 dokka-15f348dc13cd7cf05718adce6e3d43e427fba688.zip | |
Add plugins list
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/src/doc/docs/community/plugins-list.md | 15 | ||||
| -rw-r--r-- | docs/src/doc/mkdocs.yml | 2 |
3 files changed, 19 insertions, 0 deletions
@@ -68,6 +68,8 @@ To generate the documentation, use the appropriate `dokka${format}` Gradle task: Please see the [Dokka Gradle example project](https://github.com/Kotlin/kotlin-examples/tree/master/gradle/dokka/dokka-gradle-example) for an example. +We encourage users to create their own plugins and share them with the community on [official plugins list](docs/src/doc/docs/community/plugins-list.md). + #### Android Make sure you apply Dokka after `com.android.library` and `kotlin-android`. diff --git a/docs/src/doc/docs/community/plugins-list.md b/docs/src/doc/docs/community/plugins-list.md new file mode 100644 index 00000000..2559ba02 --- /dev/null +++ b/docs/src/doc/docs/community/plugins-list.md @@ -0,0 +1,15 @@ +# Dokka community plugins + +Here is a list of plugins created by dokka team or community. + +In order to add your plugin to this list it needs to be: + + * an open source project - sharing is caring so let others learn and improve your plugin + * present in any public artefacts repository like bintray + +| Plugin name | Description | Source | +| :--------- | :--------- | :------------ | +| [Kotlin as Java](https://kotlin.github.io/dokka/1.4.10/user_guide/introduction/#plugins) | Display Kotlin code as seen from Java | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/kotlin-as-java) +| [GFM](https://kotlin.github.io/dokka/1.4.10/user_guide/introduction/#plugins) | Renders documentation in a GFM format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/gfm) +| [Javadoc](https://kotlin.github.io/dokka/1.4.10/user_guide/introduction/#plugins) | Renders documentation in a Javadoc format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/javadoc) +| [Jekyll](https://kotlin.github.io/dokka/1.4.10/user_guide/introduction/#plugins) | Renders documentation in a Jekyll format | [Github](https://github.com/Kotlin/dokka/tree/master/plugins/jekyll)
\ No newline at end of file diff --git a/docs/src/doc/mkdocs.yml b/docs/src/doc/mkdocs.yml index 9b113caa..4f97553c 100644 --- a/docs/src/doc/mkdocs.yml +++ b/docs/src/doc/mkdocs.yml @@ -53,6 +53,8 @@ nav: - Introduction: developer_guide/introduction.md - Data model: developer_guide/data_model.md - Extension points: developer_guide/extension_points.md + - Community: + - Community plugins: community/plugins-list.md - About: - FAQ: about/FAQ.md - Slack channel: about/slack_channel.md |