Skip to content

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

Open
nonprofittechy wants to merge 6 commits intoNiklasRosenstein:developfrom
nonprofittechy:escape-brackets
Open

Add support for escaping { as required by MDX > v1#326
nonprofittechy wants to merge 6 commits intoNiklasRosenstein:developfrom
nonprofittechy:escape-brackets

Conversation

@nonprofittechy
Copy link
Copy Markdown

@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
Copy Markdown
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