-
Notifications
You must be signed in to change notification settings - Fork 172
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
Left angle bracket not escaped, causes parsing error with mdx #252
Comments
Hello.. yeah i can't quite remember why it was done like that but most engines don't complain, however I can't think of a reason not to escape the left angle bracket. out of interest what mdx compiler are you using? |
I'm using mdx-bundler, which uses xdm (and esbuild) :) at the moment im doing a replaceAll with some regex as a workaround. It works fine when i treat the markdown as a .md file, but in mdx i think it assumes it's the start of a component or something. |
The escape i'm currently doing in my code to work around this issue uses a negative lookbehind:
so if it has been escaped already, it doesn't try and escape it. I don't know if this helps or is relevant at all. Maybe docusaurus can do something like that |
Thanks - yeah a negative lookbehind would be the nicest solution here, but as you say would require a fix on docusaurus. still not entirely sure what the 'correct' thing to do here is. Reluctant to complicate things by introducing escaping options. |
Nevermind! Turns out the issue was that the TSDoc |
I have the same issue and i m trying to use this with the mdx plugin for gatsby |
@asturur does it help to use v3.17.1 of typedoc-plugin-markdown? |
3.17 didn't, but i m happy to try 3.17.1 |
@asturur Please do confirm if 3.17.1 fixes or not. If not I will try it with Gatsby to see if I can replicate. |
My error with 3.17 was some issue with the '#' not sure why. |
Hi!
I am trying to generate docs using an mdx compiler/bundler and
typedoc-plugin-markdown
I noticed that when a return value is, for example
Promise<void>
, the left angled bracket is not escaped. Related to this issue ?Here's a snippet of what is generated:
The text was updated successfully, but these errors were encountered: