search

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
449 stars 104 forks source link

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

Open nonprofittechy opened 2 months ago

nonprofittechy commented 2 months ago

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 commented 2 months ago

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?