如何在 npmjs.com 上管理我的包的自述文件?

How do I manage my package's readme on npmjs.com?

我实际发布 npm 包的经验非常有限,所以这可能是一个相当业余的问题。我最初的印象是,包的 npmjs.com 页面上的自述文件是通过在我的 package.json 中指定 "readme" and/or "readmeFilename" 字段来填充的。我 recently learned 事实上,这是完全不正确的,我不应该触及这些字段中的任何一个。

考虑到这一点,我该如何控制包裹页面上显示的内容?它是从 README.md 文件中自动提取的吗?如果是这样,如果我再次更改自述文件和运行 npm publish,它会自动更新吗? npm 的网站使用什么 markdown 解析器?

如果您的项目在 GitHub 上,您可以在 GitHub 中更改您的 readme.md。然后你应该在本地拉取你的存储库。 那么当你运行npm publish上最新版本时,它会取最新的readme.md文件内容。

如果由于任何原因更新文件不存在,您应该在 npm 上将您的包标记为“最新”。