org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/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> [<pkgname> ...]]
   7     npm docs (with no args in a package dir)
   8     npm home [<pkgname> [<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. You can pass multiple package names at once. If no
  16 package name is provided, it will search for a `package.json` in
  17 the current folder and use the `name` property.
  18
  19 ## CONFIGURATION
  20
  21 ### browser
  22
  23 * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
  24 * Type: String
  25
  26 The browser that is called by the `npm docs` command to open websites.
  27
  28 ### registry
  29
  30 * Default: https://registry.npmjs.org/
  31 * Type: url
  32
  33 The base URL of the npm package registry.
  34
  35
  36 ## SEE ALSO
  37
  38 * npm-view(1)
  39 * npm-publish(1)
  40 * npm-registry(7)
  41 * npm-config(1)
  42 * npm-config(7)
  43 * npmrc(5)
  44 * package.json(5)