如何让npmjs.com正确显示我的包中已存在的README.md文件?
解决npm包主页不显示README.md的问题
针对你遇到的npm包主页提示“此包没有README,请添加README以帮助用户入门”,但代码页明明能看到README.md文件的情况,可以按以下步骤排查解决:
- 确认文件名大小写:npm对文件名大小写敏感,确保你的文件是严格的
README.md(而非readme.md、Readme.md等变体)。 - 重新发布包:发布过程中的偶发问题可能导致README未被正确解析,执行以下命令重新发布:
# 先升级版本号(若需) npm version patch # 重新发布 npm publish - 检查package.json配置:确认package.json中没有错误的
readme字段配置,比如该字段是否指向了不存在的文件,或是字段名大小写错误。如有问题修正后重新发布。 - 等待缓存刷新:npm的CDN缓存可能存在延迟,重新发布后等待10-30分钟再刷新包主页查看。
- 反馈给npm官方:若以上操作都无效,说明是npm平台的bug,直接联系官方支持,提供包名及代码页中README存在的证据,请求排查修复。
内容的提问来源于stack exchange,提问作者mikemaccana
相关产品推荐
相关产品推荐

