Switch to Highlight.js syntax highlighting #230
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
frankieroberto
temporarily deployed
to
nhs-prototyp-switch-to--zxpf0t
|
The one caveat to this is that Highlight.js doesn't seem to support Nunjucks (see supported languages). For the Nunjucks code snippets I’ve set it to use the javascript syntax highlighting, which is what the NHS Service Manual website does too, and that seems to work ok. However, mixed HTML + Nunjucks code doesn’t work that well at all: 
There’s possibly a plugin out there that adds proper Nunjucks support though? |
colinrotherham
approved these changes
Feb 20, 2025
frankieroberto
temporarily deployed
to
nhs-prototyp-switch-to--zxpf0t
|
Has the chosen language stopped working in the last push? 
|
frankieroberto
temporarily deployed
to
nhs-prototyp-switch-to--zxpf0t
Well spotted! I, error, introduced a typo. 😊 Fixed in e0744b5. |
frankieroberto
temporarily deployed
to
nhs-prototyp-switch-to--zxpf0t
frankieroberto
temporarily deployed
to
nhs-prototyp-switch-to--zxpf0t
colinrotherham
approved these changes
Feb 21, 2025
|
Follow-up issue created in the backlog for exploring a fix for examples that mix HTML and Nunjucks: #231 |
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 removes the existing syntax highlighting which uses Prism, which runs client-side, and swaps it for Highlight.js, which runs server-side.
It copies across the colours and styling for both inline code examples and longer code blocks from the NHS Service manual (where they’ve been tweaked to ensure a good colour contrast).
The longer code blocks use a new
codeSnippetmacro, which also takes alanguageparameter that is passed to Highlight.js and used for syntax highlighting.Resolves #21
Screenshots