3

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

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

4

1 回答 1

3

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

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

于 2015-02-19T02:33:43.723 回答