feat(syntax-highlight): migrate to Shiki for syntax highlighting#2
Open
brodienguyen wants to merge 2 commits intohunvreus:mainfrom
Open
feat(syntax-highlight): migrate to Shiki for syntax highlighting#2brodienguyen wants to merge 2 commits intohunvreus:mainfrom
brodienguyen wants to merge 2 commits intohunvreus:mainfrom
Conversation
Replace highlight.js with Shiki for build-time syntax highlighting. Update markdown pipeline, remove highlight.js scripts, and adjust styles and documentation to reflect the new system. Update package dependencies and rename highlight.css to shiki.css.
Owner
|
I've had a quick look and adjusted a few things.
|
Author
In the const shiki = await Shiki({
themes: {
light: "github-light-default",
dark: "github-dark-default",
},
defaultColor: false, // ← This is the key setting
// ...
});When we configure Shiki with multiple themes and set defaultColor: false:
--shiki-light: #XXXXXX # (color from github-light-default)
--shiki-dark: #XXXXXX # (color from github-dark-default)
--shiki-light-bg
--shiki-dark-bg
|
This file contains hidden or 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
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 pull request migrates the site's syntax highlighting from Highlight.js to Shiki, providing build-time code highlighting with improved theme support and simplified CSS. It removes all Highlight.js dependencies, updates relevant documentation, and introduces Shiki integration into the Eleventy build pipeline. The version is also updated to a new beta release.
Migration to Shiki syntax highlighting:
@shikijs/markdown-itinto the Eleventy configuration (.eleventy.js). Shiki is now used as a Markdown-it plugin with custom theme and language aliasing. [1] [2] [3]_includes/layouts/base.njk).src/css/highlight.css) and replaces it with a new Shiki-specific stylesheet (src/css/shiki.css). The main stylesheet now importsshiki.cssinstead ofhighlight.css. [1] [2] [3] [4]Documentation updates:
docs/content/pages.mdanddocs/customize.md. [1] [2]Versioning and metadata:
0.1.2-beta.1in bothpackage.jsonand_data/site.json. [1] [2]Motivation behind this change
Why Shiki?
Some visual comparison between those two approaches
Nunjuck syntax highlighting is suppporting now with Shiki