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

Remove shell lang from some md snippets #6123

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Conversation

fvictorio
Copy link
Member

There are many markdown snippets that have sh as the info string but whose content is not shell code. This makes them be incorrectly highlighted. But the main issue is that some angle brackets are escaped:

image

To be honest, the fact that removing the info string fixes this doesn't make a lot of sense to me. I don't know why they are escaped only when a language is specified. I looked down the remark/rehype rabbit hole, but it was too deep so I went with the fix that works but that I don't understand.

@fvictorio fvictorio requested a review from a team January 8, 2025 09:55
Copy link

changeset-bot bot commented Jan 8, 2025

⚠️ No Changeset found

Latest commit: fbed13b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hardhat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 9:55am

@github-actions github-actions bot added the status:ready This issue is ready to be worked on label Jan 8, 2025
@kanej kanej added the no changeset needed This PR doesn't require a changeset label Jan 8, 2025
@kanej
Copy link
Member

kanej commented Jan 8, 2025

Closing as clearly generated by a low value LLM.

@kanej kanej closed this Jan 8, 2025
@kanej kanej reopened this Jan 8, 2025
@kanej kanej requested review from kanej and removed request for a team January 8, 2025 10:09
Copy link
Member

@kanej kanej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The generated preview does not have the escaping issue.

@fvictorio fvictorio merged commit facb21b into main Jan 9, 2025
17 of 18 checks passed
@fvictorio fvictorio deleted the fix-ignition-docs branch January 9, 2025 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changeset needed This PR doesn't require a changeset status:ready This issue is ready to be worked on
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants