diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
| commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
| tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /examples/gradle/README.md | |
| parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
| download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip | |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'examples/gradle/README.md')
| -rw-r--r-- | examples/gradle/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/gradle/README.md b/examples/gradle/README.md new file mode 100644 index 00000000..ec3b4e95 --- /dev/null +++ b/examples/gradle/README.md @@ -0,0 +1,11 @@ +# Gradle examples + +| Project | Description | +|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [dokka-customFormat-example](gradle/dokka-customFormat-example) | Demonstrates how to override `.css` styles and add custom images as assets, allowing you to change the logo used in the header. | +| [dokka-gradle-example](gradle/dokka-gradle-example) | Demonstrates how to apply Dokka in a simple single-project Gradle build, as well as how to configure it. | +| [dokka-kotlinAsJava-example](gradle/dokka-kotlinAsJava-example) | Demonstrates how to apply Dokka plugins, [Kotlin as Java](../plugins/kotlin-as-java) specifically. | +| [dokka-library-publishing-example](gradle/dokka-library-publishing-example) | Demonstrates how to integrate Dokka into the publishing process of a library, adding documentation generated by Dokka as artifacts. | +| [dokka-multimodule-example](gradle/dokka-multimodule-example) | Demonstrates how to apply and configure Dokka in a [multi-project build](https://docs.gradle.org/current/userguide/multi_project_builds.html). | +| [dokka-multiplatform-example](gradle/dokka-multiplatform-example) | Demonstrates Dokka's configuration and output for a simple [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project. | +| [dokka-versioning-multimodule-example](gradle/dokka-versioning-multimodule-example) | Demonstrates configuration of Dokka's [versioning plugin](../../../plugins/versioning), which allows readers to navigate through different versions of documentation. | |