dokka icon indicating copy to clipboard operation
dokka copied to clipboard

2.0.0 ... markdown support

Open Bradleycorn opened this issue 6 months ago • 3 comments

Question Does version 2.0.0 support markdown as an output format?

The gradle tasks seem to be there.

There's nothing in the release notes that indicate that it isn't supported.

The README still has a section on Markdown, and links to the Kotlin Dokka Markdown documentation.

However, the migration guide indicates that:

Dokka 2.0.0 only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported.

I'm also having trouble getting markdown to work with 2.0.0.

This is all a little confusing.

We rely on (github flavored) markdown for documenation, so if this feature has been removed, I need to look for another tool. In the sort term, I tried going back to 1.9.0, but it doesn't support gradle configuration cache.

Bradleycorn avatar Jun 05 '25 15:06 Bradleycorn

The fact that the native format of Kotlin docs, e.g Markdown is now not supported is a bit concerning. Maybe someone should do Dokka v3 from the ground up. As it is, I've never been happy how overly complex, slow and memory intensive Dokka is. Maybe pilfer some developers from a core team which understands parsing and document generation.

andriesfc avatar Jun 05 '25 15:06 andriesfc

But is it not supported? There's nothing in release notes to say it's not. It's still there in the readme and in the documentation on kotlin.org. The only thing that seems to indicate that it might not be supported is one sentence in the "v2 migration guide".

Bradleycorn avatar Jun 05 '25 15:06 Bradleycorn

Yeah, I too find this dropped support really painful. The excerpt that I believe @Bradleycorn is referring to is located here, and reads as follows:

Output format support: Dokka 2.0.0 only supports HTML and Javadoc output. Experimental formats like Markdown and Jekyll are no longer supported.

While there's always room for change, the phrasing seems rather final - "...are no longer supported."

tlarcher-gpsw avatar Jun 11 '25 13:06 tlarcher-gpsw