feat: highlight code syntax in markdown files #1534
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
|
You can access the deployment of this PR at https://renku-ci-ui-1534.dev.renku.ch |
|
Tearing down the temporary RenkuLab deplyoment for this PR. |
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.
Since we already use highlight.js for highlighting syntax in code files, and Showdown to convert Markdown to HTML, using showdown-highlight allows us to highlight inline code in Markdown file with a coherent color scheme.
The library is very simple, allowing for few personalizations out of the box, but it works well as long as users specify the code language. There are other solutions but they are more complicated and they may result in a different default highlighting scheme for some languages, forcing us to create a customized common color pattern.
Example:
/deploy
fix #1358