chore(gatsby-plugin-mdx): Document CommonMark option #30669
Merged
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
added
topic: MDX
type: documentation
LekoArts
approved these changes
Apr 20, 2021
LekoArts
changed the title
|
@LekoArts This is still in the documentation although the option is not valid anymore (a warning for invalid option is generated during the build)
|
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.
Description
By default,
gatsby-plugin-mdxdoesn’t seem to support CommonMark features like using\for single line breaks.Apparently, you can pass along
commonmark: true, and this will work. It works as expected from my testing. It might be because the options all get passed along to Remark? mdx-js/mdx#421 (comment)Documentation
This adds the option to the documentation.
The description could be improved, depending on whether this option is actually supported or not, etc. MDX v2 and the most recent Remark documentation also suggests that CommonMark is the default, so I’m not sure what happens to this option, or if it’s even necessary in that case. With MDX v1, adding this option solves the problem for me.
@gatsbyjs/documentation
Related Issues
mdx-js/mdx#421