Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate Markdown with no html headers #541

Open
Christopher-Li opened this issue Jun 20, 2023 · 0 comments
Open

Generate Markdown with no html headers #541

Christopher-Li opened this issue Jun 20, 2023 · 0 comments

Comments

@Christopher-Li
Copy link

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

@Christopher-Li Christopher-Li changed the title Generate Markdown with no html Generate Markdown with no html headers Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant