A modern programming language that makes developers happier.

kotlinlang

Hi! Is it possible with Dokka to add Markdown files and create tabs or sections from those .md files that are separate from the API references?

I’d like to have two main tabs or modules: Guides and API Reference, and also add links to navigate between them.

Can this be done entirely with Dokka, or should I use another documentation tool for the guides and keep Dokka only for the API reference?

It is not possible directly within Dokka. With only Dokka, you can add custom text in the module and package pages but not create new pages. You can also customize the title of pages. For example: <https://vite-kotlin.opensavvy.dev/api-docs/>

I'm working on a plugin that integrates Dokka pages into a Material for MkDocs site, so you can have your text pages and your API reference in a single site. It's not stable yet, but it's near stability. <https://vite-kotlin.opensavvy.dev/api/-vite%20for%20-gradle/index.html|Example> • <https://dokka-mkdocs.opensavvy.dev/index.html|Documentation>

Thx, I assumed it wasn't possible and started using mkdocs. When I see the stable version of your plugin, I'll probably use it :heart_hands:

Hey, but I'm not using  material theme. Perhaps you could make it abstract from the theme so that I can use it.

Out of curiosity, does this still use dokka HTML, or does it extract the data and generate markdown? Do you have a plugin in dokka v2 that generates markdown?

&gt; Perhaps you could make it abstract from the theme so that I can use it.
I've never used regular MkDocs so I don't really know how much of what I generate is specific to Material. For example, I don't touch the theme in any way, so maybe it works just as well with regular MkDocs.

&gt; When I see the stable version of your plugin, I'll probably use it :heart_hands:
If you want to follow the progress, here are the two blockers:
• <https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/issues/18>
• <https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/issues/21>
Once these are fixed, it's all small things afterwards.

&gt; Do you have a plugin in dokka v2 that generates markdown?
Yes, that's what I'm doing.