Dokka for MkDocs 0.3.0 is out! This is the first ...

# opensavvy

[CLOVIS]

Dokka for MkDocs 0.3.0 is out!

This is the first version you can try yourself! Add the plugin dev.opensavvy.dokkatoo-mkdocs to a Gradle project in the same folder as your Material for MkDocs mkdocs.yml configuration file. In the nav section, add the following magic lines where you want the Dokka output to be generated:

# !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! #
# !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! #

and finally, use the usual dokkatoo configuration to add a dependency on the projects you want to see included in the documentation website. Finally, run the task embedDokkaIntoMkDocs. See the example: Gradle • MkDocs

All the Gradle projects you selected will be included in the final MkDocs website. Keep in mind, this is still very experimental, and a lot of information is missing. For example, type aliases are currently not included in the documentation.

You can see a simple example project deployed here: https://opensavvy.gitlab.io/automation/dokka-material-mkdocs/docs/api/-library%20module/index.html

See the full changelog • Visit the repository