标签：学习   read   重要   查看   创建文件   lis   markdown   文档   文件   

包括文档(readme.md)

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

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

如何更新ReadMe文件

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

npm学习（九）之README.md文件

标签：学习   read   重要   查看   创建文件   lis   markdown   文档   文件   

原文地址：https://www.cnblogs.com/kunmomo/p/11221880.html