search

twoslashes / twoslash

Markup for generating rich type information in your documentations ahead of time.
https://twoslash.netlify.app/
MIT License
530 stars 19 forks source link

Missing documentation for `@...` notations? #48

Open jasonkuhrt opened 2 months ago

jasonkuhrt commented 2 months ago

Hey,

I've integrated VitePress and Twoslash, thanks for all the work you've done here.

IIUC things like @log are styled when e.g. using ts twoslash. However, it seems that these @ notations are not documented in Twoslash website.

I would be happy to make a contribution to the docs if I am correct. But perhaps I am misunderstanding where the @log etc. functionality originates from.

Also another example here https://shiki.style/packages/twoslash:

CleanShot 2024-08-15 at 10 44 57@2x

jasonkuhrt commented 2 months ago

Ok, so nicely it seems that there is at least inline doc for @ notations. That's great!

CleanShot 2024-08-15 at 11 05 24@2x