How can I add a footer to Kotlin Dokka docs?

Question

I am looking for a way to include text in the footer of all Dokka generated docs. I am not seeing this option being advertised by the Gradle or Maven plugins for Dokka.

Is this possible? Can you point me to a sample?

Answer 1

You can set your own footer by overriding the Dokka footer message.

{module}/build.gradle

tasks.named("dokkaHtml").configure {
  pluginsMapConfiguration.set(
    [
      "org.jetbrains.dokka.base.DokkaBase": """{
        "footerMessage": "Your New Footer!"
      }"""
    ]
  )
}

This will replace the Copyright 20xx in the current footer. For further details on multi-module / css support, recommend checking out the source below.

Source: Raywenderlich