Kotlin
Bring back Markdown support
Version 2.0 no longer supports generating MarkDown documentation. Please don't abandon Markdown. We have a library and we use Dokka to generate documentation and publish it to Bitbucket wiki for the repo. The wiki does not support HTML.
+1
Lots of documentation solutions are Markdown based. For our use-case, Dokka without Markdown support essentially becomes useless.
Yeah, starting from DGPv2 we are phasing out markdown output format support (it was always in an Alpha status), as we currently have not enough resources to maintain it and it's popularity and quality is rather low and we would like to concentrate more on the HTML format
While on current moment the artifacts are there and it's possible to enable it via custom Gradle plugin (similar to how javadoc is supported) it's not decided if those will be available in future
As mentioned above:
Lots of documentation solutions are Markdown based.
But most of them are still using different Markdown flavors or custom extensions on top of it, and so generated by Dokka markdown will not be able to properly support all features of those solutions. Could you please share specific solutions you would like Dokka to integrate with, so that it will be more clear what is needed and why Dokka HTML format is not an option?
For example, it might make more sense to create a separate plugin for Dokka similar to https://opensavvy.gitlab.io/automation/dokka-material-mkdocs/docs/
MkDocs is what we would like to support. Not aware of that plugin from before, will look into it.
At least in my experience, having a ton of different tools and many different places to retrieve information is effective death to usefulness (I have the same opinion of Writerside - nice concept, but less than useful in practice because it's built on a very "one project = one doc premise). The places I've worked where these kind of tools became really useful, used cross-project tools. like Backstage (which is MkDocs based) and similar. Where I work now, we have our own "home-grown" documentation system, but also built around MkDocs. For dev-centric documentation, I'll go over Markdown-based solutions over others any day of the week, because it's something all devs are comfortable with, even the most crazy backend devs.
Markdown can also be a good format for AI model inferencing. HTML can be too verbose and cluttered when feeding as input to AI models.
Could you please share specific solutions you would like Dokka to integrate with, so that it will be more clear what is needed and why Dokka HTML format is not an option?
We would like dokka to continue to produce Github Flavored Markdown (GFM). We publish documentation as markdown files in our repository. This works very well for us, and I was very disappointed to see it was not there when attempting to update to 2.0.0.
