Mermade / widdershins

OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
https://mermade.github.io/reslate
MIT License
1.48k stars 321 forks source link

Generate Markdown with no html headers #541

Open Christopher-Li opened 1 year ago

Christopher-Li commented 1 year ago

Is your feature request related to a problem? Please describe. The generated markdown includes h1 and h2 tags which some markdown parsers struggle with, namely nextra. Our documentation has Parameter headings but because nextra cannot parse html, the Parameter heading doesn't show and is confusing

Describe the solution you'd like I would like the option to not have html headers and to use markdown #s. The plan would be to add a boolean header of convertHtmlHeadersToMarkdown. I am willing to work on a PR

Describe alternatives you've considered Since I don't want the html headers, I considered removing them from the template directly, but I assume that many users still want this, so it isn't a good solution

Additional context N/A