Mermade / widdershins

OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown

Home Page:https://mermade.github.io/reslate

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Generate Markdown with no html headers

Christopher-Li opened this issue · comments

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