Auto Generated JSDoc Docs

[saolsen]

I've been using https://jsr.io/ for some stuff and one really great feature is that docs are auto-generated from JSDoc comments.

For example, I can push a file like this, and it renders docs like this.

It would be really cool if vals had builtin docs that worked the same way.

I believe that the jsr docs are based on deno doc.

If I take the source of a val like this and generate docs like

deno doc --html --name="my_module" val.tsx

I get output that looks like this, which is a very good start. I think you would probably be able to leverage deno doc to do most of the work, though, of course running that on every val save adds a bunch of new work to manage.

[stevekrouse]

Awesome idea! Thanks!!

[saolsen]

Oh wow, there's also this site https://doc.deno.land/ where you can just put in the esm.town url and get the docs! https://doc.deno.land/https://esm.town/v/saolsen/jsdoc_example?v=4/~/f

Looks like it's open source too, maybe it could be forked. It looks like it consumes the json output of deno doc.

deno doc --json --name="my_module" val.tsx

[tmcw]

Awesome - yeah this seems very feasible to implement and we'll look into it soon!