Skip to content
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

Add shiki two slash #880

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add shiki two slash #880

wants to merge 4 commits into from

Conversation

yashovardhan
Copy link
Member

@yashovardhan yashovardhan commented Aug 25, 2024

Adds shiki two slash. Getting it working was a problem since docusaurus 3 is not officially supported. Additionally, it seems to work only for ts, and not other languages properly. Although most problems have been fixed with manual js code addition, there is still a problem of imports. Any dynamic code import doesn't seem to work as expected. Finally, magic comments don't work with it as well.

shikijs/twoslash#125
https://github.com/excaliburjs/Excalibur/blob/90a4f7165db853a6afb53b214d7088d2e7b0ea4f/site/docusaurus.config.ts
https://www.typescriptlang.org/dev/twoslash/
https://github.com/kasper573/yas/blob/dcf62f7637f7a85f9ce1598851bc26d938314df5/packages/remark-html-to-jsx/package.json
shikijs/twoslash#125
https://vocs.dev/docs/guides/twoslash
https://shikijs.github.io/twoslash/
https://www.npmjs.com/package/remark-shiki-twoslash
https://github.com/shikijs/twoslash/blob/main/README.md
https://github.com/twoslashes/twoslash?tab=readme-ov-file

Copy link

vercel bot commented Aug 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
web3auth-docs ❌ Failed (Inspect) Aug 26, 2024 3:53am

@yashovardhan yashovardhan added help wanted Extra attention is needed blocked The PR is blocked, please don't merge enhancement New feature or request labels Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked The PR is blocked, please don't merge enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant