dokka icon indicating copy to clipboard operation
dokka copied to clipboard

Output in JSON instead of HTML/Markdown

Open jamesbradlee opened this issue 1 year ago • 1 comments

Question Is it possible to export all documentation as a JSON file instead of HTML or Markdown?

I have a use case where I have a multi-module project that I want to generate documentation for. In this multi-module project I need to have both API documentation (provided by Dokka), but also regular documentation hand-written in markdown. These should go together in a custom generator that generates more json files indexed by pagefind, and then finally, uploaded to a blob store where our documentation site will see the version, then download and cache it for offline-use. The HTML content is a website that comes separate from the documentation.

Keeping the documentation site and the documentation data separate allows us to maintain the website for both API references and guides on all versions without having to rebuild the documentation sources.

jamesbradlee avatar Mar 28 '24 06:03 jamesbradlee

Not at this moment, please take a look at: https://github.com/Kotlin/dokka/issues/621#issuecomment-1978753299

whyoleg avatar Mar 28 '24 07:03 whyoleg