npm學習(九)之README.md文件


包括文檔(readme.md)

npm建議您包含一個readme文件來記錄您的包。自述文件必須有文件名readme.md。文件擴展名.md表示該文件是一個標記(markdown)文件。當有人發現您的包時,該文件將出現在npm網站上。在開始之前,請查看一些包頁面,了解可以添加到readme文件中的信息,並了解為什么這一點如此重要。 

  • 使用任何文本編輯器創建文件。
  • 將它保存在項目目錄中,名稱為readme.md
  • 發布時,此文檔將顯示在下載包的web頁面上

如何更新ReadMe文件

除非發布包的新版本,否則不會更新站點上顯示的自述文件,因此需要運行npm version patch和npm publish來更新站點上顯示的文檔。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM