I am generating a documentation for my library by ...
# getting-started
i
I am generating a documentation for my library by using dokka. I will eventually upload this documentation and make it public. There is always a slight chance that someone will open this docs page from Search engine results. I wonder how can I reference back this doka doc to a Github repo or external project page? Is there a way to add a link in header or setup custom home page?
a
The templates are editable, so you can add a link to the header or footer, or completely edit the home page, if you like https://kotlinlang.org/docs/dokka-html.html#templates You can add a
(source)
link that takes you to the source code (example) https://kotlinlang.org/docs/dokka-gradle.html#source-link-configuration For a link in the header, watch this space… https://github.com/Kotlin/dokka/issues/2948
👍 1
i
Source link is quite nice - I will explore this a bit more.
BTW just noticed that coroutines Kdoc page has these links - this is dokka build in or custom stuff?
a
that’ll probably be a custom template, although I can’t find the config for it in the kx.coroutines source code…
it’s probably somewhere in here https://github.com/JetBrains/kotlin-web-site
h
Afaik, the dokka template including the footer isn’t published.
Oh, wait, there are published: https://github.com/JetBrains/kotlin-web-site/tree/master/dokka-templates You’re right, Adam.
👍 1
w
You might be interested in #dokka
👍 1