fix(streamdown): disable singleTilde in remark-gfm to prevent ~ from rendering as strikethrough#546
Open
sleitor wants to merge 1 commit into
Open
fix(streamdown): disable singleTilde in remark-gfm to prevent ~ from rendering as strikethrough#546sleitor wants to merge 1 commit into
sleitor wants to merge 1 commit into
Conversation
…rendering as strikethrough Set singleTilde: false in the default remark-gfm configuration so that single ~ characters are not interpreted as strikethrough markup. Only double tildes (~~text~~) will trigger strikethrough, consistent with GitHub GFM behavior. Fixes vercel#545
Contributor
|
@sleitor is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #545
Single tilde (
~foo~) was incorrectly rendered as strikethrough becauseremark-gfmdefaults tosingleTilde: true. This PR setssingleTilde: falsein the defaultremark-gfmconfiguration, consistent with GitHub GFM behavior where only double tildes (~~text~~) create strikethrough.Changes
packages/streamdown/index.tsx: Changed defaultremarkGfmoptions from{}to{ singleTilde: false }packages/streamdown/__tests__/single-tilde.test.tsx: Added tests verifying single~is not rendered as strikethrough while~~still works.changeset/fix-single-tilde-545.md: Changeset for patch releaseTesting