feat(gatsby-remark-prism-js): add additional html escapes #20156
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
address test failures
e232ad0 to
d3e4ba6
Compare
…k-prismjs-html-escape
freiksenet
suggested changes
Dec 17, 2019
…ub.com/patricksimonian/gatsby into feat/gatsby-remark-prismjs-html-escape
freiksenet
previously approved these changes
Dec 19, 2019
freiksenet
approved these changes
Dec 20, 2019
|
@patricksimonian Thank you very much! |
3 tasks
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
This feature adds the option
escapeEntitiesto thegatsby-remark-prismjsplugin. This option allows users to provide an additional set of characters to be escaped when MD files are processed by this plugin.As outlined in issue #20128. I found it necessary to allow for additional HTML entities to be escaped when processing markdown files. I had initially authored a local plugin to do this but then it ran into incompatibilities with the prism js plugin. Since
gatsby-remark-prismjsalready escapes a small set of HTML entities, I felt adding this feature to this particular plugin was most appropriate.Documentation
Documentation has been added to the plugin's README.md file.
Related Issues
Fixes #20128