创建 NPM 包，如何记录它们？

Question

我正在创建一些 NPM 包，我想知道为它们编写用户文档的最佳实践是什么（因为信息很少，并且搜索与npm package documentationnpm 文档相关的任何内容不可避免地会产生他们自己）。

发布包时，注册中心从哪里获取首页文档？

我想拥有一个不错的README.md文件是任何浏览 github repo 的人的第一步，但我也想提供一种方便的方式来阅读已编译的 JsDoc。

Answer 1

package.json包的 npm 包页面从包中的字段（名称、描述、依赖项等）或 npm 数据库本身（下载图、最后发布的、星号、依赖项等）获取顶部表中的数据。下面的内容只是从 markdown 转换为 HTML 的 README.md。

所以README.md大多数包所做的就是“好”。如果您想将 jsdoc 构建为 HTML 并将其发布到某个地方（也许只是 git 存储库本身），我建议您在 README 中突出地链接到该文件并称其为“good”。