NPM\-DOCS

Section: (1)
Updated: July 2020
Page Index
 

NAME

npm-docs - Docs for a package in a web browser maybe  

Synopsis

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

Description

This command tries to guess at the likely location of a package's documentation URL, and then tries to open it using the --browser config param. You can pass multiple package names at once. If no package name is provided, it will search for a package.json in the current folder and use the name property.  

Configuration

 

browser

Default: OS X: "open", Windows: "start", Others: "xdg-open"
Type: String

The browser that is called by the npm docs command to open websites.  

registry

Default: https://registry.npmjs.org/
Type: url

The base URL of the npm package registry.  

See Also

npm help view
npm help publish
npm help registry
npm help config
npm help npmrc
npm help package.json


 

Index

NAME
Synopsis
Description
Configuration
browser
registry
See Also