# Dokka for Material for MkDocs

A [Dokka](https://github.com/Kotlin/dokka) output format tailored for inclusion into a [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) website.

This repository is composed of:
- [The Dokka renderer](renderer) that generates the Material for MkDocs pages,
- [The Gradle plugin](dokka-mkdocs) that configures the project,
- [An example project](docs/example).

To learn more about the project, read [the documentation](https://dokka-mkdocs.opensavvy.dev/).

## License

This project is licensed under the [Apache 2.0 license](LICENSE).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).
- To learn more about our coding conventions and workflow, see the [OpenSavvy website](https://opensavvy.dev/open-source/index.html).
- This project is based on the [OpenSavvy Playground](docs/playground/README.md), a collection of preconfigured project templates.

If you don't want to clone this project on your machine, it is also available using [DevContainer](https://containers.dev/) (open in [VS Code](https://code.visualstudio.com/docs/devcontainers/containers) • [IntelliJ & JetBrains IDEs](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html)). Don't hesitate to create issues if you have problems getting the project up and running.