From 3c3d2e47abb732a006b899d40162758568c41e34 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Tue, 28 Mar 2023 23:30:23 +0200 Subject: [PATCH] Fix example project links in README (#2943) Fixes #2932 The table was copy-pasted from the parent examples directory without changing relative links --- examples/README.md | 18 +++++++++--------- examples/gradle/README.md | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/examples/README.md b/examples/README.md index 5f78cb6bd4..a79ffe2573 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,15 +2,15 @@ ## Gradle -| 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. | +| 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. | ## Maven diff --git a/examples/gradle/README.md b/examples/gradle/README.md index ec3b4e9545..04a448e6ce 100644 --- a/examples/gradle/README.md +++ b/examples/gradle/README.md @@ -1,11 +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. | +| 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. |