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

时间:2015-02-18 22:22:38

标签: node.js npm readme

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

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

1 个答案:

答案 0 :(得分:2)

如果您的项目在github上,您可以在github中更改readme.me。然后你应该把你的存储库拉到本地存储库中。 然后,当您为最新版本运行npm publish时,它将采用最新的readme.md文件内容。 出于任何原因,如果没有更新的文件,您应该使用latest标记用npm标记您的包。

希望这会对你有所帮助。

由于