npm学习之README.md文件

Posted kunmomo

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了npm学习之README.md文件相关的知识,希望对你有一定的参考价值。

包括文档(readme.md)

npm建议您包含一个readme文件来记录您的包。自述文件必须有文件名readme.md。文件扩展名.md表示该文件是一个标记(markdown)文件。当有人发现您的包时,该文件将出现在npm网站上。在开始之前,请查看一些包页面,了解可以添加到readme文件中的信息,并了解为什么这一点如此重要。 

  • 使用任何文本编辑器创建文件。
  • 将它保存在项目目录中,名称为readme.md
  • 发布时,此文档将显示在下载包的web页面上

如何更新ReadMe文件

除非发布包的新版本,否则不会更新站点上显示的自述文件,因此需要运行npm version patch和npm publish来更新站点上显示的文档。

以上是关于npm学习之README.md文件的主要内容,如果未能解决你的问题,请参考以下文章

GitHub 项目中的 README 和 README.md 有啥区别?

git 怎么刷新readme.md文件

Gitee中 README.md文件的编辑和使用

GitHub上README.md教程

[转]GitHub上README.md教程

readme.md