What is the best way to display a TypeScript type ? #3744
Closed
JesusTheHun
started this conversation in
General
Replies: 2 comments
-
shiki twoslash - https://shiki.style/packages/vitepress |
Beta Was this translation helpful? Give feedback.
0 replies
-
@brc-dd that's pretty solid ! EDIT : nvm, it was a build mistake on netlify |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
This is general question, not really specific to Vitepress (but tied to its features and limitations).
How do you present, document, a TypeScript type ?
In my documentation I want to introduce the user to some types that do some cool stuff and can help him when using my library, but I always struggle to define what is the best way. Half the time I can come up with an example of use case, but it does not always suffice to demonstrate the benefits.
So far I've used the comment queries style, but I'm wondering if there is a better way.
Beta Was this translation helpful? Give feedback.
All reactions