aboutsummaryrefslogtreecommitdiff
path: root/examples/gradle/README.md
blob: 04a448e6cef26ee67efa8f9e3d6f6c0b3bb6f332 (plain)
1
2
3
4
5
6
7
8
9
10
11
# Gradle examples

| Project                                                                      | Description                                                                                                                                                        |
|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [dokka-customFormat-example](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](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](dokka-kotlinAsJava-example)                     | Demonstrates how to apply Dokka plugins, [Kotlin as Java](../../plugins/kotlin-as-java) specifically.                                                              |
| [dokka-library-publishing-example](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](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](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](dokka-versioning-multimodule-example) | Demonstrates configuration of Dokka's [versioning plugin](../../plugins/versioning), which allows readers to navigate through different versions of documentation. |