Skip to content

Commit

Permalink
Add plugins list
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcinAman authored and sellophane committed Oct 19, 2020
1 parent c482ed6 commit 15f348d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
15 changes: 15 additions & 0 deletions docs/src/doc/docs/community/plugins-list.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 2 additions & 0 deletions docs/src/doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 15f348d

Please sign in to comment.