Skip to content

Commit 83f0885

Browse files
authored
ktl-695 chore: support Dokka HTML customization (#3388)
1 parent d0ee143 commit 83f0885

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

build.gradle

+4
Original file line numberDiff line numberDiff line change
@@ -355,3 +355,7 @@ allprojects { subProject ->
355355
}
356356
}
357357
}
358+
359+
tasks.named("dokkaHtmlMultiModule") {
360+
pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])
361+
}

dokka-templates/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Customize Dokka's HTML.
2+
To customize Dokka's HTML output, place a file in this folder.
3+
Dokka will find a template file there. If the file is not found, a default one will be used.
4+
This folder is defined by the templatesDir property.

gradle/dokka.gradle.kts

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ tasks.withType(DokkaTaskPartial::class).configureEach {
2727

2828
tasks.withType(DokkaTaskPartial::class).configureEach {
2929
suppressInheritedMembers.set(true)
30+
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${rootProject.projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))
31+
3032
dokkaSourceSets.configureEach {
3133
jdkVersion.set(11)
3234
includes.from("README.md")

0 commit comments

Comments
 (0)