Use nu-highlight for code blocks
#1719
Draft
Conversation
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
hustcer
reviewed
Dec 29, 2024
Comment on lines
+10
to
+12
| - name: Install Nushell | ||
| run: cargo install nu --locked --no-default-features | ||
|
|
There was a problem hiding this comment.
Install Nu by this way is quite slow, try this one: https://github.com/hustcer/setup-nu
Comment on lines
+211
to
+218
| this.options.defaultColor = 'onedarkpro'; | ||
| // this doesn't work at the top-level for some reason | ||
| this.options.colorReplacements = { | ||
| // make one-dark-pro background color the same as dark-plus | ||
| '#282c34': '#1e1e1e', | ||
| // HACK: change color of comments, since nu-highlight can't highlight them | ||
| '#abb2bf': '#80858f', | ||
| }; |
There was a problem hiding this comment.
It's better to extract these a few lines to a function like adjustTheme, so we can reuse it later
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.
Work in progress. Adds a Shiki transformer which uses the
highlight.nuscript to highlight nushell code blocks usingnu-highlight.Also adds the ability to add code before the true code block, for examples which require extra code to work:
Only the
str mycommandline will show up in the final code block, but it will not be error highlighted since thestr mycommanddefinition exists.The output of
nu-highlightheavily depends on bold fonts for readability, so we should make sure all of the fonts listed in--code-font-familysupport bold. Notably, on my machine the font fell back to Andale Mono, which did not have a bold face. I was able to get boldansihighlighting working install consolas, which is a higher priority font in--code-font-familyand does have a bold face.Need to rebase this on #1718 assuming that gets merged.