You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: