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.

Sign up for GitHub

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

Jump to bottom

Add shiki-twoslash tooltips to docsite #1670

Closed
Tracked by #1317
cspotcode opened this issue Mar 3, 2022 · 1 comment · Fixed by #1645
Closed
Tracked by #1317

Add shiki-twoslash tooltips to docsite #1670

cspotcode opened this issue Mar 3, 2022 · 1 comment · Fixed by #1645
Milestone
10.7.0

Comments

@cspotcode
Copy link
Collaborator

For example, get fancy IntelliSense tooltips in your code samples:
https://mael.dev/clipanion/docs/getting-started

For us, a unique challenge: we must also render down to README.md. Might need a processing step in our README generator to strip shiki twoslash syntax.

https://github.com/shikijs/twoslash/tree/main/packages/docusaurus-preset-shiki-twoslash
https://github.com/shikijs/twoslash
@cspotcode cspotcode mentioned this issue Mar 3, 2022
Open
17 tasks
@cspotcode cspotcode changed the title Add shiki-twoslash and equivalent json schema-powered tooltips to docsite Add shiki-twoslash tooltips to docsite Mar 4, 2022
@cspotcode
Copy link
Collaborator Author

Implemented and closed by #1645

@cspotcode cspotcode added this to the 10.7.0 milestone Mar 4, 2022
@cspotcode cspotcode linked a pull request Mar 4, 2022 that will close this issue
chore(website): upgrade Docusaurus, format files, add shiki-twoslash #1645
Merged
@cspotcode cspotcode mentioned this issue Mar 4, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
10.7.0
Development

Successfully merging a pull request may close this issue.

chore(website): upgrade Docusaurus, format files, add shiki-twoslash Josh-Cena/ts-node
1 participant
@cspotcode