Settings

Theme

Tsdocs.dev: rustdoc style documentation for JavaScript libraries

tsdocs.dev

3 points by pastelsky 2 years ago · 2 comments

Reader

pastelskyOP 2 years ago

tsdocs.dev helps browse reference typescript documentation for any package or version of a library.

So you don't have to rely on library authors to provide upto date reference docs for different versions of their library

  • rikroots 2 years ago

    So I gave this a go for my canvas library[1]. The results are better than I expected, especially as (I assume) everything beyond the readme is being generated from my library's (handwritten) .d.ts file!

    One question I do have: are there annotations and/or additional details that I could be adding to the file, or library, which could make the output more useful for anyone wanting to use this as a reference to the library? Also: how permanent is the output - is it going to regenerate every time someone hits that endpoint or is it robust enough for me to add a link to it from the library's website?

    [1] - https://tsdocs.dev/docs/scrawl-canvas/8.10.4

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection