A modern programming language that makes developers happier.

kotlinlang

working.jpeg

not working.jpeg

<#C0F4UNJET|dokka>

*Question*
I'm using Dokka to generate Kotlin documentation for a single module.
I'd like to display a different name on my index page instead of the module name.

When I pass the actual module name via the 'moduleName' field, it displays fine, and the additional markdown files that I add using the 'includes.from' option also display correctly in HTML.

However, when I pass a different name that I want to display on the index page via the 'moduleName' field, it doesn't load the files from 'includes'.

*How can I set a different name to display on the index page ?*

```tasks.withType(DokkaTask.class).configureEach {
    dokkaSourceSets {
        named("main") {
            moduleName.set("mkplayer")
            moduleVersion.set("$mkplayer_version")
            includes.from("../docsDokka/src/mkplayersdk.md")
            outputDirectory.set(file("../docsDokka/src/tempOutput/html"))
        }
    }

    String dokkaBaseConfiguration = """
    {
        "footerMessage": "(c) Player SDK for Android. All rights reserved."
    }
    """
    pluginsMapConfiguration.set(
        ["org.jetbrains.dokka.base.DokkaBase": dokkaBaseConfiguration]
    )
}```
*Installation*
• Operating system: macOS
• Build tool: Gradle v8.3.0
• Dokka version: 1.9.10

*Screenshots*
when moduleName is same, data from 'playersdk.md' is shown
_moduleName.set("mkplayer")_

when moduleName is different, data from 'playersdk.md' is not shown
_moduleName.set("Player SDK for Android")_

If I understand correctly, the `moduleName` should be exactly what you use in the `# Module &lt;moduleName&gt;` at the top of the markdown file.

For example, <https://opensavvy.gitlab.io/pedestal/api-docs/progress-coroutines/index.html|here> I wanted to have a complex name, so <https://gitlab.com/opensavvy/pedestal/-/blob/823b1e1ae80d2ca8d7391918db9bc52f8c0bb6ae/progress-coroutines/README.md?plain=1#L1|the markdown file follows the same name>.

However, I'm using Dokkatoo and not Dokka directly so I'm not 100% sure it's the same thing.

Hi <@UFGCACPE0>, thanks for your reply.
If you check out these <https://docs.gradle.org/current/kotlin-dsl/index.html|Gradle docs (link)>, you'll notice they have a different header name than the module name.
Any ideas on how we can achieve this?
Or is there an option to hide the module name?

When I mentioned "header name," I was referring to the displayed name, which differs from the module name.

In above case, the module name appears as only `Gradle` (visible in the sidebar), while the displayed name is `Kotlin DSL Reference for Gradle`.

Ah. Sorry, no, I don't know how to do that.

As you can see in my example though, you can customize the module name and still have the markdown file show correctly.

Thanks for your kind inputs :slightly_smiling_face:

Hey, sorry for delay
Unfortunately, on current moment it's not possible to use different name for modules (in navigation page), header and so on
Here is what Gradle is doing here to achieve this (may be this will be helpful for your use case):
1. `Kotlin DSL Reference for Gradle` on page (on the right side) comes from `Module.md` <https://github.com/gradle/gradle/blob/243526492e347036ceda430b88f1a96b00c2fb6b/platforms/documentation/docs/src/docs/kotlin/Module.md?plain=1|(source)> + they hide original module name via `css` styles <https://github.com/gradle/gradle/blob/243526492e347036ceda430b88f1a96b00c2fb6b/platforms/documentation/docs/src/docs/kotlin/styles/gradle.css#L39-L51|(source)>
2. `Kotlin DSL Reference for Gradle` in header comes from 'a little hack' in CSS where they prefix header name with additional text <https://github.com/gradle/gradle/blob/243526492e347036ceda430b88f1a96b00c2fb6b/platforms/documentation/docs/src/docs/kotlin/styles/gradle.css#L35-L37|(source)> - most likely it's possible to fully replace text in header in the same way