Skip to content
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

Open
nonprofittechy opened this issue Apr 20, 2024 · 0 comments · May be fixed by #326
Open

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

nonprofittechy opened this issue Apr 20, 2024 · 0 comments · May be fixed by #326
Assignees

Comments

@nonprofittechy
Copy link

Environment

  • Pydoc-Markdown Version: 4.8.2
  • Python Version: v3.10
  • Operating System: Ubuntu 22.04

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.

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 a pull request may close this issue.

2 participants