NiklasRosenstein / pydoc-markdown

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

Pydoc-markdown output may not compile in MDX v2 or v3 #325

Open nonprofittechy opened 7 months ago

nonprofittechy commented 7 months ago

Environment

Describe the bug

When using pydoc-markdown to generate Markdown files for use with Docusaurus 3, the files are no longer guaranteed to load. The most common problem seems to be failure to escape { and } in the docstring. See:

https://docusaurus.io/docs/migration/v3#bad-usage-of-

Expected behavior

The output works correctly with Docusaurus v2. It would be great to have an option to escape these characters that are not supported in MDX v2 and greater, as required for compatibility with Docusaurus v3.