From 043b483909b6872ce61024a7176a807375061c62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 14 Mar 2026 20:05:37 +0100 Subject: [PATCH] build(junie): Create basic guidelines for Junie --- .junie/guidelines.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .junie/guidelines.md diff --git a/.junie/guidelines.md b/.junie/guidelines.md new file mode 100644 index 0000000..704713a --- /dev/null +++ b/.junie/guidelines.md @@ -0,0 +1,14 @@ +# Dokka for Material for MkDocs + +This project is a Dokka plugin to embed Kotlin documentation into Material for MkDocs. + +Structure: + +- `renderer/src/main/kotlin/MaterialForMkDocsPlugin.kt`: Dokka plugin that generates MkDocs-style Markdown pages +- `dokka-mkdocs/src/main/kotlin/DokkaMkDocsPlugin.kt`: Gradle plugin that configures the Dokka plugin and generates the MkDocs navigation bar +- `docs/example/example-core/src/commonMain/kotlin`: Example Kotlin code for testing the plugin +- `docs/website/docs/api`: Location of the generated Markdown for the example + +You can regenerate the example output by running `./gradlew :website:embedDokkaIntoMkDocs -p docs`. + +Users should not require editing their `mkdocs.yml` or MkDocs overrides to be able to use this project. -- 2.51.2