npm docs

npm docs 功能

在网络浏览器中获取软件包的文档

npm docs 使用

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

npm home [<pkgname> [<pkgname> ...]]
npm home .

alias: home

npm docs 说明

此命令尝试猜测软件包文档 URL 的可能位置，然后尝试使用 –browser config 参数将其打开。

您可以一次传递多个软件包名称。

如果没有提供程序包名称，它将 package.json 在当前文件夹中搜索 a 并使用该 name 属性。

如果没有找到会指向仓库的 Readme.md

配置

浏览器

• 默认值：OS X：“open”，Windows “start”，其他：“xdg-open”
• 类型：String

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

注册表

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

npm 程序包注册表的基本 URL。