npm 文档 docs

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

概要

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

描述

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

配置

browser 浏览器

• 默认值：OS X: open, Windows: start, 其他:xdg-open
• 类型：String

由npm docs命令调用以打开网站的浏览器。

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

设置为 true 使用默认系统 URL 打开浏览器。

registry 注册表

• 默认值：https : //registry.npmjs.org/
• 类型：Url

npm 注册表的基本 URL。

workspace 工作区

• 默认：
• 类型：String（可多次设置）

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

workspace配置的有效值为：

• 工作区名称
• 工作区目录的路径
• 父工作区目录的路径（将导致选择所有嵌套工作区）

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

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

workspaces 工作区

• 默认值：false
• 类型：Boolean

启用在所有已配置工作区的上下文中运行命令。

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