我正在创建一些NPM包，我想知道为他们编写用户文档的最佳实践（因为信息非常少，并且搜索与{{1相关的任何内容）不可避免地会产生npm文档本身。）
发布包时，注册表从哪里获取首页文档？
我想拥有一个漂亮的npm package documentation文件是任何浏览github repo的人的第一步，但我也想提供一种方便的方法来阅读已编译的JsDoc。
答案 0 :(得分：2)
包的npm包页面从包中的package.json字段（名称，描述，依赖关系等）或从npm数据库本身获取顶部表中的数据（下载图，最后一个）出版，明星，家属等）。下面的内容就是从markdown转换为HTML的README.md。
所以大多数包都是好的README.md。如果你想将你的jsdoc构建成HTML并在某个地方发布（也许就是git repo本身），我建议只在README中突出显示它并将其称为好。
答案 1 :(得分：1)
我发现了一个有趣的包，可以从jsdoc发出README.md：