-
Notifications
You must be signed in to change notification settings - Fork 103
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
Pydoc-markdown output may not compile in MDX v2 or v3 #325
Comments
nonprofittechy
added a commit
to nonprofittechy/pydoc-markdown
that referenced
this issue
Apr 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: