-
Notifications
You must be signed in to change notification settings - Fork 454
Description
Question
I have a few questions.
-
How can I replace
andoridJvm source
string with something likeGitHub
in sources tab of the documentation?
-
How can I set a custom favicon (which may be different from the logo in the page header) for the document?
My current solution is to name an image filelogo-icon.svg
and add it as an asset in the Dokka settings. But I want to name the image file something else likefavicon.svg
and also want to be able to use other formats like PNG as well. -
Do you think it would be better for the methods in Dokka Gradle plugin to be converted to properties and also avoid double negative names?
So, for example,noAndroidSdkLink.set(false)
be renamed to something likeuseAndroidSdkLink = true
orisAndroidSdkLinkEnabled = true
orenableAndroidSdkLink = true
or similar. -
I really liked the previous theme of Dokka HTML. Can I somehow enable it for my docs?
-
Updating the files defined as custom assets or styles is not reflected in the output when I re-run the dokkaHtml task. So, I had to run Gradle clean and then run dokkaHtml again.
-
Configuring the plugin options is not easy. On Windows it is even harder because the paths should either be normalized or escaped:
pluginsMapConfiguration.set( mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "customStyleSheets": ["${file("dokka/logo-styles.css").path.replace('\\','/')}"], "customAssets" : [ "${file("dokka/logo.svg").path.replace('\\', '/')}", "${file("dokka/logo-icon.svg").path.replace('\\', '/')}" ], "separateInheritedMembers": true }""" ) )
Is there any better way to do this?
Installation
- Operating system: Windows 11
- Build tool: Gradle v7.0.2
- Dokka version: 1.6.21