deps/npm/doc/cli/npm-docs.md

   1 npm-docs(1) -- Docs for a package in a web browser maybe
   2 ========================================================
   3
   4 ## SYNOPSIS
   5
   6     npm docs <pkgname>
   7     npm docs (with no args in a package dir)
   8     npm home <pkgname>
   9     npm home (with no args in a package dir)
  10
  11 ## DESCRIPTION
  12
  13 This command tries to guess at the likely location of a package's
  14 documentation URL, and then tries to open it using the `--browser`
  15 config param. If no package name is provided, it will search for
  16 a `package.json` in the current folder and use the `name` property.
  17
  18 ## CONFIGURATION
  19
  20 ### browser
  21
  22 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
  23 * Type: String
  24
  25 The browser that is called by the `npm docs` command to open websites.
  26
  27 ### registry
  28
  29 * Default: https://registry.npmjs.org/
  30 * Type: url
  31
  32 The base URL of the npm package registry.
  33
  34
  35 ## SEE ALSO
  36
  37 * npm-view(1)
  38 * npm-publish(1)
  39 * npm-registry(7)
  40 * npm-config(1)
  41 * npm-config(7)
  42 * npmrc(5)
  43 * package.json(5)