網站導覽
目錄
npm-docs
在網路瀏覽器中開啟套件文件
選擇 CLI 版本
目錄
概要
npm docs [<pkgname> [<pkgname> ...]]alias: home
說明
此指令會試著猜測套件文件 URL 的可能位置，然後試著使用 --browser 組態 參數開啟它。你可以一次傳遞多個套件名稱。如果沒有提供套件名稱，它會在目前資料夾中搜尋 package.json 並使用 name 屬性。
組態
瀏覽器
- 預設值：OS X：
"open"，Windows："start"，其他："xdg-open" - 類型：null、布林或字串
npm 指令呼叫的瀏覽器，用於開啟網站。
設為 false 以抑制瀏覽器行為，並改為將 URL 列印到終端機。
設為 true 以使用預設系統 URL 開啟器。
登錄
- 預設值："https://registry.npmjs.org/"
- 類型：網址
npm 登錄的基礎網址。
工作區
- 預設
- 類型：字串（可設定多次）
在過濾僅執行此設定選項所定義的工作區時，啟用在目前專案設定的工作區內容中執行指令。
workspace 設定的有效值為
- 工作區名稱
- 工作區目錄的路徑
- 父工作區目錄的路徑（將導致選取該資料夾中的所有工作區）
當設定 npm init 指令時，可設定為尚未存在的資料夾，以建立資料夾並將其設定為專案中的全新工作區。
此值不會匯出至子程序的環境。
工作區
- 預設：null
- 類型：null 或布林
設定為 true 以在所有設定的工作區中執行指令。
明確設定為 false 將導致 install 等指令完全忽略工作區。未明確設定時
- 操作
node_modules樹狀結構（安裝、更新等）的指令會將工作區連結到node_modules資料夾中。- 執行其他動作（測試、執行、發布等）的指令將在根專案中操作，除非在workspace設定中指定一個或多個工作區。
此值不會匯出至子程序的環境。
包含工作區根目錄
- 預設：false
- 類型：布林
在為指令啟用工作區時，包含工作區根目錄。
為 false 時，透過 workspace 設定指定個別工作區，或透過 workspaces 旗標指定所有工作區，將導致 npm 僅在指定的工作區中操作，而非根專案。
此值不會匯出至子程序的環境。
