Ensure to strip any code block annotation after language name #46
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
anlambert
force-pushed
the
ensure-code-block-annotation-strip
branch
from
cb3472e to
bda5853
Compare
Some markdown files can contain extra code block annotations after the language name, separated by commas. Such extra annotations break code highlighting after processing by showdown-highlight as the language name ends up invalid and cannot be found by highlight.js. So ensure to strip these extra annotations to fix HTML rendering.
anlambert
force-pushed
the
ensure-code-block-annotation-strip
branch
from
bda5853 to
bc7e24e
Compare
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.
Some markdown files can contain extra code block annotations after the language name, separated by commas.
Such extra annotations break code highlighting after processing by
showdown-highlightas the language name ends up invalid and cannot be found byhighlight.js.For instance, the README of https://github.com/budziq/rust-skeptic repository contains such code block annotations and we can see they are properly rendered by GitHub. However, when browsing the archived version of that repository in Software Heritage, whose website uses
showdownjsandshowdown-highlight, we can see the renderings of such code blocks are broken.So ensure to strip these extra annotations to fix HTML rendering.
I also added a GitHub Actions job to execute the tests of
showdown-highlight.