node-webcrypto-ossl icon indicating copy to clipboard operation
node-webcrypto-ossl copied to clipboard

Add documentation generation to package.info

Open rmhrisk opened this issue 8 years ago • 4 comments

We can add generation of derived documentation via tsdoc/typedoc or similar then apply fork of docdash: https://github.com/clenemt/docdash

"script": { "generate-docs": "node_modules/.bin/jsdoc -c jsdoc.json" } This way we can have standalone documentation showing how to use the library.

rmhrisk avatar Aug 27 '16 05:08 rmhrisk

Presumably, you want to use typedoc or tsdoc, not jsdoc? I don't know if the docdash theme will work with the output of either of those.

hildjj avatar Sep 01 '16 17:09 hildjj

I was a bit over zealous with copy and paste, the goal is to have generated documents.

If the Docdash theme will not work we have some guys we can make one that is visually similar that will work with typedoc/tsdoc.

Do you have experience with either?

rmhrisk avatar Sep 01 '16 20:09 rmhrisk

No. They both look... early.

hildjj avatar Sep 01 '16 20:09 hildjj

Agreed, was hoping you might be able to provide assurance it was OK :)

rmhrisk avatar Sep 01 '16 21:09 rmhrisk