feat: added dokka templates directory for kotlinlang (#377)

* feat: added dokka templates directory for kotlinlang

* Use `projectDir.resolve`

Co-authored-by: Filipp Zhinkin <[email protected]>

* Move DokkaMultiModuleTask to kotlinx-io-dokka.gradle.kts

* Use `projectDir.resolveSibling`

Co-authored-by: Filipp Zhinkin <[email protected]>

---------

Co-authored-by: Konstantin Chernenko <[email protected]>
Co-authored-by: Filipp Zhinkin <[email protected]>

Author: 3 people

build-logic/src/main/kotlin/kotlinx/io/conventions/kotlinx-io-dokka.gradle.kts

@@ -3,6 +3,7 @@
  * Use of this source code is governed by the Apache 2.0 license that can be found in the LICENCE file.
  */
 
+import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import java.net.URL
 
@@ -11,6 +12,14 @@ plugins {
 }
 
 tasks.withType<DokkaTaskPartial>().configureEach {
+    pluginsMapConfiguration.set(
+        mapOf(
+            "org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${
+                projectDir.resolveSibling("dokka-templates")
+            }"""
+        )
+    )
+
     dokkaSourceSets.configureEach {
         includes.from("Module.md")
 
@@ -34,3 +43,15 @@ tasks.withType<DokkaTaskPartial>().configureEach {
         )
     }
 }
+
+tasks.withType(DokkaMultiModuleTask::class.java) {
+    pluginsMapConfiguration.set(
+        mapOf(
+            "org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${
+                projectDir.resolve(
+                    "dokka-templates"
+                )
+            }" }"""
+        )
+    )
+}

dokka-templates/README.md

@@ -0,0 +1,12 @@
+# Dokka's template customization
+To provide unified navigation for all parts of [kotlinlang.org](https://kotlinlang.org/),
+the Kotlin Website Team uses this directory to place custom templates in this folder
+during the website build time on TeamCity.
+
+It is not practical to place these templates in the kotlinx.metadata repository because they change from time to time
+and aren't related to the library's release cycle.
+
+The folder is defined as a source for custom templates by the templatesDir property through Dokka's plugin configuration.
+
+[Here](https://kotlinlang.org/docs/dokka-html.html#templates), you can
+find more about the customization of Dokka's HTML output.