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

Add support for escaping { as required by MDX > v1 #326

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

nonprofittechy
Copy link

@nonprofittechy nonprofittechy commented Apr 20, 2024

Fix #325

This adds a new parameter to the markdown processor, escape_curly_braces_in_docstring that defaults to false.

When enabled, the docstring will get a second escaping pass that just escapes {.

@NiklasRosenstein
Copy link
Owner

Thanks for the PR! Are you sure the curly braces need to be escaped unconditionally for MDX, such as in inline and multiline code blocks?

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

Successfully merging this pull request may close these issues.

Pydoc-markdown output may not compile in MDX v2 or v3
2 participants