Hi, Is there a way to not overwrite the CSS files or index.html when I run `./gradlew dokkaHtmlMulti...

# dokka

[Adrian Landborn]

Hi,
Is there a way to not overwrite the CSS files or index.html when I run ./gradlew dokkaHtmlMultiModule ?
What I am trying to achieve is to replace the path for the logo. 🧵

[Adrian Landborn]

This is how my project level task looks like.

pluginManager.withPlugin("org.jetbrains.dokka") {
    afterEvaluate {
        this.tasks.withType(org.jetbrains.dokka.gradle.DokkaMultiModuleTask::class) {
            outputDirectory.set(file("documentation/html"))
            includes.from("documentation/packages.md")
        }

        dependencies {
            "dokkaHtmlPlugin"("org.jetbrains.dokka:android-documentation-plugin:1.6.21")
        }
    }
}

[Ignat Beresnev]

Hi! Not 100% sure what exactly you're trying to do, but if you want to set a custom logo, it's available in Dokka's configuration

Documentation is not very good atm, but there are some examples: https://kotlin.github.io/dokka/1.6.21/user_guide/gradle/usage/#configuration-options

[Ignat Beresnev]

The name for the logo should be logo-icon.svg

pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
    customAssets = listOf(file("logo-icon.svg"))
}

[Adrian Landborn]

I have looked through the docs but do not understand where this “pluginConfiguration” should go.

I just want to replace the icon basically.

[Adrian Landborn]

I managed to get this working. Does not look good but it works…

pluginManager.withPlugin("org.jetbrains.dokka") {
    afterEvaluate {
        this.tasks.withType(org.jetbrains.dokka.gradle.DokkaMultiModuleTask::class) {
            pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "customAssets": ["${file("documentation/logo-icon.svg")}"] }"""))

            outputDirectory.set(file("documentation/html"))
            includes.from("documentation/packages.md")
        }

        dependencies {
            "dokkaHtmlPlugin"("org.jetbrains.dokka:android-documentation-plugin:1.6.21")
        }
    }

}

[Adrian Landborn]

The conversion from Groovy to Kotlin however does not look that nice

[Ignat Beresnev]

It should be like this: https://gist.github.com/IgnatBeresnev/ed9b88d20f5d48322f313b53232790e9

[Ignat Beresnev]

^ but that's for .kts scripts. For groovy you have to use pluginsMapConfiguration, unfortunately

[Adrian Landborn]

Isn’t that the other way around. We do use Kotlin DSL

[Ignat Beresnev]

Nope, pluginsMapConfiguration is basically for groovy and if you don't want to depend on dokka-base in your buildscripts

[Adrian Landborn]

Why do you have the code in “DokkaTaskPartial” I want this in the main gradle file.

[Ignat Beresnev]

You can put it in your main gradle file, it's not related 🙂

It's not that code is in DokkaTaskPartial, but it's configuring DokkaTaskPartial. Should be just DokkaTask if you have a single-module project

[Adrian Landborn]

Then we should be able to use this in the project level gradle file for DokkaMultiModuleTask.

Not sure why the imports does not resolve though. 🤔

[Adrian Landborn]

image.png

[Ignat Beresnev]

Did you add a dependency to dokka-base in your buildscript as shown in the gist and the documentation?

buildscript {
    dependencies {
       classpath("org.jetbrains.dokka:dokka-base:1.6.21")
    }
}

[Adrian Landborn]

ahh 😄