【问题标题】：Creating NPM packages, how to document them?创建 NPM 包，如何记录它们？
【发布时间】：2014-09-10 00:32:43
【问题描述】：
我正在创建一些 NPM 包，我想知道为它们编写用户文档的最佳实践是什么（因为信息很少，并搜索与 npm package documentation 相关的任何内容不可避免地会屈服于 npm 文档本身）。
当你发布一个包时，注册中心从哪里获取首页文档？
我想拥有一个不错的README.md 文件是浏览 github 存储库的任何人的第一步，但我也想提供一种方便的方式来阅读编译后的 JsDoc。
【问题讨论】：
标签：
node.js
documentation
package
npm
jsdoc
【解决方案1】：
包的 npm 包页面从包中的 package.json 字段（名称、描述、依赖项等）或 npm 数据库本身（下载图、上次发布、明星，家属等）。下面的东西只是从 Markdown 转换为 HTML 的 README.md。
所以一个好的README.md 是大多数包所做的。如果您想将您的 jsdoc 构建为 HTML 并将其发布到某个地方（可能只是 git repo 本身），我建议您在 README 中显着地链接到它并称其为好。