-
-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
experiment with using shiki twoslash #95
Open
johnnyreilly
wants to merge
14
commits into
main
Choose a base branch
from
feat/twoslash
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
❌ Deploy Preview for johnnyreilly-preview failed. 🔨 Explore the source changes: b9b0864 🔍 Inspect the deploy log: https://app.netlify.com/sites/johnnyreilly-preview/deploys/616c67987419aa0007a9f763 |
Hey @orta I'm starting to write a blog post about using twoslash - I have been somewhat cheeky with the title image... 😉 I hope this doesn't offend? |
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 is a place to experiment with
docusaurus-preset-shiki-twoslash
for syntax highlighting in place of using the default of Prism.JSIf others want to hack on this:
git clone https://github.com/johnnyreilly/blog.johnnyreilly.com.git cd blog.johnnyreilly.com/blog-website git checkout feat/twoslash yarn yarn start
Then browse to http://localhost:3000/2021/08/14/typescript-4-4-more-readable-code
You can see that it works:
However, there's been issues which I'll document so peeps can help me maybe:
yarn start
takes about 10 minutes to get started. It's worth saying that I have more than two hundred blog posts and that may be a factor.Thoughts
I'm guessing that deactivating Prism is something to consider - but I think it does all it's work at runtime so I suspect it's not an issue.