jsdocs-io
Try on local packages?
It'd be nice to iterate on my package and see how the docs look w/o having to publish to npm with each change..
Is there a way to try a local build of jsdocs-io on unpublished packages?
Hi @mighdoll, thanks for the issue!
Currently there isn't a way as the main focus is on published npm packages. However, I've run some test and it should be feasible to support analyzing local packages generated with npm pack.
The process should look like this:
- Author: Write code
- Author: Build step (e.g.,
npm run build) - Author: Generate package (i.e.,
npm pack) - Local jsdocs.io instance: Analyze
package.tgz
It could be done by navigating for example to localhost:3000/local/path/to/my/package.tgz where local is the endpoint for local packages followed by the absolute path of the package tarball.
That would be great! It'd be nice to be able to view doc changes locally before npm publishing a new rev.
... I think you're suggesting that jsdocs-io could work that way, not that it already does. I gave it a quick try and it didn't work for me yet.. but if it's supposed to work already, I'll try again.