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
Characters <
and >
are not being escaped using Docusarus 3.
#502
Comments
Both opening and closing brackets should be escaped. Would you mind pasting in your source? This looks like documentation of a class constructor but you should see this
|
@aamir1995 This plugin generates plain markdown files, docusaurus treats these (by default in V3) as mdx (which is not vanilla md) files. I had the exact same error you had, i fixed it by adding
to |
@CoderIllusionist thanks for the suggestion! I was having issues with using { } in a JS comment throwing an acorn error and using your suggestion fixed it. |
@CoderIllusionist thanks man! this setting made my day :-) |
The following generated markdown will result in an error while using the plugin with Docusarus 3 and MDX 3.
Probably need to escape these,
The issue can be reproduced by pasting the above problematic markdown in MDX Playground
This is also mentioned in upgrade guide of Docusarus V3 https://docusaurus.io/docs/migration/v3#common-mdx-problems
Environment Info:
Docusarus version:
3.0.0
@mdx-js/react:
3.0.0
docusaurus-plugin-typedoc:
1.0.0-next.21
typedoc-plugin-frontmatter:
0.0.2
typedoc-plugin-markdown:
4.0.0-next.27
The text was updated successfully, but these errors were encountered: