目錄

關於套件 README 檔案

目錄

為協助他人於 npm 上找到您的套件，並在專案中使用您的程式碼時有良好的體驗，我們建議在套件目錄中加入 README 檔案。您的 README 檔案可以包含套件中程式碼的安裝、設定和使用說明，以及使用者可能覺得有用的任何其他資訊。README 檔案將顯示在套件頁面上。

npm 套件 README 檔案必須位於套件的根目錄中。

建立和新增 README.md 檔案至套件

  1. 在文字編輯器中，於您的套件根目錄建立一個名為 README.md 的檔案。
  2. 在 README.md 檔案中，加入關於您的套件的有用資訊。
  3. 儲存 README.md 檔案。

注意： 檔案副檔名 .md 表示 Markdown 檔案。有關 Markdown 的更多資訊，請參閱 GitHub 指南「精通 Markdown」。

更新現有套件 README 檔案

只有在您發佈套件的新版本時，README 檔案才會在套件頁面上更新。如要更新您的 README 檔案

  1. 在文字編輯器中，更新 README.md 檔案的內容。

  2. 儲存 README.md 檔案。

  3. 在命令列中，於套件根目錄執行下列指令

    npm version patch
    npm publish
在 GitHub 上編輯此頁面
2 貢獻者lukekarrysethomson
最後由 lukekarrys 於 2023 年 10 月 23 日 編輯