Add syntax highlighter to code blocks in articles #167
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
Calinou
reviewed
Aug 22, 2020
YuriSizov
force-pushed
the
codeblock-syntax-highlighting
branch
from
d789b23
to
4a19c36
Compare
|
Thanks! |
Merged
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.
This PR adds a syntax highlighter in the form of Highlight.js to the articles. Highlight.js has a benefit of having a dedicated ruleset for GDScript maintained by our contributors. The change is retroactive and affects all existing articles/news.
I picked a dark theme called
Obsidianfor this, but there are a lot of other options if you think that something else would fit better. I naturally lean towards dark themes for code, but there may be a reason to use a lighter theme instead.The retroactivity of this PR has a side effect. All code blocks that don't require any highlighting should be marked as
plaintext. If the language is not specified, Highlight.js will try to "detect" it. For example, this is Ruby to it:/cc @akien-mga @Calinou