Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-docs (1)

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

NPM-DOCS(1)                                                        NPM-DOCS(1)



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 docu-
       mentation 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
       o Default: OS X: "open", Windows: "start", Others: "xdg-open"

       o Type: String


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

   registry
       o Default: https://

       o Type: url


       The base URL of the npm package registry.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help view

       o npm help publish

       o npm help 7 registry

       o npm help config

       o npm help 7 config

       o npm help 5 npmrc

       o npm help 5 package.json





NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018                      NPM-DOCS(1)