Typejuice: Docs generator for .d.ts files inspired by godoc

this is cool! are there any examples hosted anywhere? (the screenshot looks promising) -- and do you think it's fast enough to run the parser/generator on a cloudflare worker or something? part of what makes godoc so nice is that you can just aim godoc.org (or pkg.go.dev) at the url of your repo and you don't have to generate or host it yourself

velut · 4 years ago

Hi,

I'm the author of the website mentioned by zebracanevra that does just that.

When a user requests the documentation for a package hosted on npm, a lambda function (Vercel/AWS) runs the analysis process using the TypeScript compiler.

The TS compiler is slow though and this process can take several seconds to finish for packages of medium and larger sizes (you can see the exact time at the bottom of a generated documentation page).

zebracanevra · 4 years ago

For that use case, maybe try https://www.jsdocs.io/ ?

Works well in my tests.

Here's some discussion from when it was last posted: https://news.ycombinator.com/item?id=27107832

eat_veggies · 4 years ago

hyuuu · 4 years ago

does it work on regular typescript files, not definition files specifically? I can see this to be very useful for surfacing in code docs

xeromal · 4 years ago

I've used Typedoc and it works very well for me. You'll need to tweak the configuration options a bit to get what you want but it makes solid documentation.

https://typedoc.org/

This is my command for example

`npx typedoc --excludePrivate --plugin typedoc-plugin-missing-exports lib/foo-bar.ts`