Hello! I wanted to know if there is a simple way t...
# dokka
n
Hello! I wanted to know if there is a simple way to add custom markdown files. Like there is the kdoc, and I want to add an example/tutorial section in the menu, imported from markdown files (would seem to be the easiest option) There has to be an option or plugin for this (otherwise I’m making a plugin for it)
h
https://kotlinlang.slack.com/archives/C0F4UNJET/p1748658187027599 You can add custom markdown files, but they need to start with the identifier to put it into the correct dokka site
n
I saw that but it’s not like a totally new section with only markdown data right? I was thinking of something like the ktor website, where you have tutorials. But directly included in the dokka website as a section (like modules)
h
Yeah, it’s not, and the issue is still open. Ktor does not use Dokka for tutorials but Writerside.
n
I get it. I just also found it there are issues opened about this for years: https://github.com/Kotlin/dokka/issues/1965 Do you think making a plugin is worth it? Or contributing to the original project would be better? (I currently have no idea how it works behind the scenes, I just saw the basics of making a plugin)
h
I have no experience with Dokkas plugin API or about Dokkas contribution’s policy or experience. I am just a normal dokka user. But if you plan to use dokka with mkdocs, use Ivan’s plugin: https://gitlab.com/opensavvy/automation/dokka-material-mkdocs
❤️ 1
o
Yeah, additional MD pages are not supported out of the box. We had a POC a while ago, but there were many open questions, specifically about how to combine the API reference and those MD docs and how to customize names and paths there. At that time, it was decided not to invest more resources there because the cost vs. benefits of this approach were not clear when solutions like Writer Side, Mkdocs, and others already supported much richer functionality. Feel free to leave your use case on the issue mentioned above
❤️ 1