目录
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/"
- 类型：URL
npm 注册表的基本 URL。
工作区
- 默认值
- 类型：字符串（可以设置多次）
启用在当前项目的配置工作区的上下文中运行命令，同时通过仅运行此配置选项定义的工作区来过滤。
对于 workspace 配置的有效值是：
- 工作区名称
- 工作区目录的路径
- 父工作区目录的路径（将导致选择该文件夹中的所有工作区）
当为 npm init 命令设置时，这可以设置为尚未存在的工作区的文件夹，以创建文件夹并将其设置为项目中的全新工作区。
此值不会导出到子进程的环境中。
工作区
- 默认值：null
- 类型：null 或布尔值
设置为 true 以在所有配置工作区的上下文中运行命令。
明确将其设置为 false 将导致 install 等命令完全忽略工作区。当未明确设置时
- 对
node_modules树进行操作的命令（install、update 等）将链接工作区到node_modules文件夹中。 - 执行其他操作的命令（test、exec、publish 等）将在根项目上运行，除非在workspace配置中指定了一个或多个工作区。
此值不会导出到子进程的环境中。
include-workspace-root
- 默认值：false
- 类型：布尔值
在为命令启用工作区时包含工作区根目录。
当为 false 时，通过 workspace 配置指定单个工作区，或通过 workspaces 标志指定所有工作区，将导致 npm 仅对指定的工作区进行操作，而不是对根项目进行操作。
此值不会导出到子进程的环境中。
