npm docs

在 Web 浏览器中打开包的文档

概要

npm docs [<pkgname> [<pkgname> ...]]

alias: home

描述

此命令尝试猜测包的文档 URL 的可能位置，然后尝试使用 --browser 配置参数打开它。您可以一次传递多个包名。如果没有提供包名，它将在当前文件夹中搜索 package.json 并使用 name 属性。

配置

browser

• Default: OS X: "open", Windows: "start", Others: "xdg-open"
• Type: null, Boolean, or String

使用 npm 命令调用浏览器打开网站。

设置为 false 禁止浏览器行为，而是将 url 打印到终端。

设置为 true 使用默认系统 url 打开。

registry

• Default: "https://registry.npmjs.org/"
• Type: URL

npm 注册中心的基本 URL。

workspace

• Default:
• Type: String (可以设置多次)

启用在当前项目的已配置工作区的上下文中运行命令，同时通过仅运行此配置选项定义的工作区进行过滤。

workspace 配置的有效值如下:

• 工作区名称
• 工作区目录的路径
• 父工作区目录的路径（将导致选择该文件夹中的所有工作区）

为 npm init 命令设置时，可以将其设置为尚不存在的工作空间的文件夹，以创建文件夹并将其设置为项目中的全新工作空间。

此值不会导出到子进程的环境中。

workspaces

• Default: null
• Type: null or Boolean

设置为 true 将在所有配置的工作区中运行该命令。

显式地将此设置为 false 将导致如下命令 install 完全忽略工作空间。当没有显式设置时:

• 在 node_modules 树上操作的命令 (install, update, etc.) 时，将把工作区链接到 node_modules 文件夹中。做其他事情的命令 (test, exec, publish, etc.) 将在根项目上操作，除非在 workspace 配置中指定了一个或多个工作空间。

此值不会导出到子进程的环境中。

include-workspace-root

• Default: false
• Type: Boolean

当为某个命令启用工作区时，请包含工作区根目录。

当为 false 时，通过 workspace 配置指定单个工作空间，或通过 workspaces 标志指定所有工作空间，将导致 npm 仅在指定的工作空间上运行，而不是在根项目上运行。

此值不会导出到子进程的环境中。