chore(gatsby-plugin-mdx): Add comment why rehype-slug is required #32128
Conversation
This file contains 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
gatsbot
bot
added
the
status: triage needed
LekoArts
changed the title
LekoArts
added
topic: remark/mdx
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation
I added a comment describing why
rehype-slugisrequired in this example config, which illustrates the use of rehype plugins withgatsby-plugin-mdx. I was referencing this example earlier today, but I missed the require line forrehype-slug, which causedrehype-autolink-headingsto do nothing. Apparently, this has happened to someone else as well; see StackOverflow.I realize that this example config is perhaps intended to illustrate the use of rehype plugins in general, not
rehype-autolink-headersspecifically. I thought I'd put it out here though, and let you all decide 🙂