I am developing several NPM packages, and I would like to know what is best suited for writing user documentation for them (since there is very little information there and finding something related npm package documentationinevitably leads to npm documents themselves).
npm package documentation
When you publish a package, where does the registry get the document on the main page?
I assume having a good file README.mdis the first step for anyone looking at the github repository, but I would like to provide a convenient way to read the compiled JsDoc.
README.md
npm package.json (, , ..) npm ( , , , ..). - README.md, HTML.
package.json
, README.md - , . jsdoc HTML - (, git), README .
, README.md jsdoc:
https://www.npmjs.org/package/jsdoc-to-markdown