-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Fixes rendering of HTML comments inside markdown code blocks #3638
Conversation
🦋 Changeset detectedLatest commit: a10a873 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for the fix.
Going to cc @hippotastic as I know they were working on a lower-level fix to this issue. |
I think that's a good quick fix for this particular side effect of our current way to allow HTML comments. LGTM! The fix I'm working on has a far greater scope and will improve interleaving of Markdown and HTML/JSX elements as well as JS expressions in general. There are plenty of scenarios that currently throw parser errors (also with HTML comments), which will become valid afterwards. But this takes some time, and having a quick fix for a single common scenario like this one in the meanwhile is great in my opinion! |
Thanks for the reviews! Very excited to see what you're cooking up, @hippotastic! |
…ro#3638) * JS comment wrappers should be removed from HTML comments in code blocks * chore: add changeset
Closes #3460
Changes
Fixes a bug where HTML comments weren't being rendered properly inside markdown code blocks
Testing
Added tests to the
markdown/remark
andvite-plugin-markdown
packages to test the remark plugin and markdown page renderingDocs
None, bug fix only