node.js – 创建NPM包,如何记录它们？

我正在创建一些NPM包,我想知道为他们编写用户文档的最佳实践是什么(因为信息非常少,搜索与npm包文档相关的任何内容不可避免地产生于npm文档本身).

发布包时,注册表从哪里获取首页文档？

我想有一个很好的README.md文件是浏览github repo的任何人的第一步,但我想提供一种方便的方法来读取已编译的JsDoc.

包的npm包页面从包中的package.json字段(名称,描述,依赖项等)或从npm数据库本身获取顶部表中的数据(下载图,最后发布,明星,家属)等).下面的内容就是从markdown转换为 HTML的README.md.

所以大多数软件包都是一个很好的README.md.如果你想将你的jsdoc构建成HTML并在某个地方发布(也许就是git repo本身),我建议只在README中突出显示它并将其称为好.