Fix bad fenced-code-block labels. Formatting to help other markdown parsers. #34
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.
Identify the Bug
Bad labels on fenced code blocks prevented syntax highlighting on much of the code examples. Some uncommon labels like
bash
break highlighting on non-github parsing libs. Incorrect labels like labeling.ini
config files asshell
break highlighting everywhere.Description of the Change
Changed fenced code block labels.
Changed 3 long in-lined code blocks to fenced blocks. Altered accompanying quote blocks for clarity. This was just my own pedantic preference.
Changed
json
toJSON
in one line because it's and acronym and my cursor was already there.Alternate Designs
Alternates break parsers. It's a bug. Excluding the inline blocks and JSON, of course
Possible Drawbacks
Some of my changes are not conformant to R Markdown, but are consistent with the rest of the project. Specifically, the lack of extra linefeed characters (newline).
Verification Process
Parser stopped breaking. Checked the output visually for unintended side-effects
Release Notes
Most examples now have correct syntax highlighting and improved visual clarity. Non-jekyll gfm parsers should now be able to properly identify fenced code blocks by their labels.