Skip to content

Commit 0f4c62d

Browse files
authored
ktl-873 chore: support Dokka HTML customization (#239)
1 parent 409d51b commit 0f4c62d

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

core/build.gradle.kts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,8 @@ val downloadWindowsZonesMapping by tasks.registering {
347347
}
348348

349349
tasks.withType<AbstractDokkaLeafTask>().configureEach {
350+
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))
351+
350352
dokkaSourceSets.configureEach {
351353
// reportUndocumented.set(true) // much noisy output about `hashCode` and serializer encoders, decoders etc
352354
skipDeprecated.set(true)

core/dokka-templates/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Dokka's template customization
2+
To provide unified navigation for all parts of [kotlinlang.org](https://kotlinlang.org/),
3+
the Kotlin Website Team uses this directory to place custom templates in this folder
4+
during the website build time on TeamCity.
5+
6+
It is not practical to place these templates in the kotlinx-datetime repository because they change from time to time
7+
and aren't related to the library's release cycle.
8+
9+
The folder is defined as a source for custom templates by the templatesDir property through Dokka's plugin configuration.
10+
11+
[Here](https://kotlin.github.io/dokka/1.7.20-SNAPSHOT/user_guide/output-formats/html/#custom-html-pages), you can
12+
find more about the customization of Dokka's HTML output.

0 commit comments

Comments
 (0)