npm 文檔 docs

在 Web 瀏覽器中打開包的文檔

概要

npm docs [<pkgname> [<pkgname> ...]]
aliases: home

描述

此命令嘗試猜測包文檔 URL 的可能位置，然后嘗試使用--browser?配置參數(shù)打開它。你可以一次傳遞多個包名稱。如果未提供包名稱，它將在當前文件夾中搜索package.json并使用name屬性。

配置

browser 瀏覽器

• 默認值：OS X:?open, Windows:?start, 其他:xdg-open
• 類型：String

由npm docs命令調用以打開網站的瀏覽器。

設置為 false 抑制瀏覽器行為，而是將 url 打印到終端。

設置為 true 使用默認系統(tǒng) URL 打開瀏覽器。

registry 注冊表

• 默認值：https?:?//registry.npmjs.org/
• 類型：Url

npm 注冊表的基本 URL。

workspace 工作區(qū)

• 默認：
• 類型：String（可多次設置）

允許在當前項目的已配置工作區(qū)的上下文中運行命令，同時通過僅運行此配置選項定義的工作區(qū)進行過濾。

workspace配置的有效值為：

• 工作區(qū)名稱
• 工作區(qū)目錄的路徑
• 父工作區(qū)目錄的路徑（將導致選擇所有嵌套工作區(qū)）

為該npm init命令設置時，可以將其設置為尚不存在的工作區(qū)的文件夾，以創(chuàng)建該文件夾并將其設置為項目中的全新工作區(qū)。

此值不會導出到子進程的環(huán)境中。

workspaces 工作區(qū)

• 默認值：false
• 類型：Boolean

啟用在所有已配置工作區(qū)的上下文中運行命令。

此值不會導出到子進程的環(huán)境中。