How much work is it to maintain a dokka custom for...

# dokka

[CLOVIS]

How much work is it to maintain a dokka custom format?

I'd like to integrate Dokka into a MkDocs website. The Markdown format gets me 90% of the way there, but there are a few minor visual things that I'd like to change. I also need a list of all pages and their hierarchy (to inject into the table of contents).

Considering I have very little time to actually manage this, do you think it is reasonable to fork the markdown format and adapt it, or will this take forever and break every release?

[glureau]

Hi there! I've made a markdown-dokka plugin, not sure that's what you used but curious about your rendering issues. If you can tell me a bit more I may be able to improve my plugin.

[CLOVIS]

I used the Markdown format that is included with Dokka itself, is this what you're talking about?

[glureau]

Oh gosh I misread and was thinking about Mermaid, sorry about that 😬 Have a nice day

[CLOVIS]

Ahah no problem! But do drop a link to your plugin, that may be useful in the future 😇

[CLOVIS]

I assume you have touched the internals of Dokka formats, so maybe you can answer my question anyway, about the difficulty to maintain it?

[glureau]

https://github.com/glureau/dokka-mermaid
Mine was very superficial as it's mainly loading a local js file + calling a js method : no problem to maintain. Since Dokka 1.9.20, they introduced a new API specific for redering code blocks, so I guess even easier (btw I forgot to review that one 😕 https://github.com/glureau/dokka-mermaid/pull/6)

[glureau]

I guess mixing Dokka + Mkdocs will be more complex and tricky than my little plugin, I would not compare them tbh.

[CLOVIS]

I guess so. I'm hoping that, since I'm essentially taking the existing Markdown format and changing a few things, it will be relatively minor but… I'm a bit scared of the stability of APIs.