Document how to create a preview of the JSDoc

[cdauth]

I am following the “Writing documentation” guide to add JSDoc comments to my code. To see if my documentation is formatted right and links between symbols work, I would like to preview my rendered JSDoc without having to publish a version of my package after each change.

The documentation links to this blog post for additional information. That blog post mentions the deno doc command. However, my project runs on Node.js and uses TSC, thus I cannot use .ts extensions in my imports, which is required by Deno due to denoland/deno#2506. Thus the deno doc command fails with a lot of errors that it cannot find my imports.

Also, someone mentioned in #582 that the docs generated by Deno are different than the ones on JSR, so they are not suitable as a preview.

It would be nice if the docs would show how to generate a preview for the JSDoc as it will be shown on JSR. So far I haven’t found a way to achieve this.

[lucacasonato]

@cdauth You can run DENO_FUTURE=1 deno doc --unstable-sloppy-imports <entrypoint>. I'll make sure this is cleaned up and added to the docs.

[birkskyum]

It would be great to have a web preview of the docs, which would be easier to browse than the deno doc terminal

[crowlKats]

@birkskyum you can specify the --html flag which will generate html pages that you can navigate. now, it wont be exactly identical, but quite close. it should suffice to get a general idea

[birkskyum]

@crowlKats , that worked excellent, thanks!