npm-docs.1 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .TH "NPM\-DOCS" "1" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-docs\fR \- Docs for a package in a web browser maybe
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm docs [<pkgname> [<pkgname> \.\.\.]]
  9. npm docs \.
  10. npm home [<pkgname> [<pkgname> \.\.\.]]
  11. npm home \.
  12. .fi
  13. .RE
  14. .SS Description
  15. .P
  16. This command tries to guess at the likely location of a package's
  17. documentation URL, and then tries to open it using the \fB\-\-browser\fP
  18. config param\. You can pass multiple package names at once\. If no
  19. package name is provided, it will search for a \fBpackage\.json\fP in
  20. the current folder and use the \fBname\fP property\.
  21. .SS Configuration
  22. .SS browser
  23. .RS 0
  24. .IP \(bu 2
  25. Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
  26. .IP \(bu 2
  27. Type: String
  28. .RE
  29. .P
  30. The browser that is called by the \fBnpm docs\fP command to open websites\.
  31. .SS registry
  32. .RS 0
  33. .IP \(bu 2
  34. Default: https://registry\.npmjs\.org/
  35. .IP \(bu 2
  36. Type: url
  37. .RE
  38. .P
  39. The base URL of the npm package registry\.
  40. .SS See Also
  41. .RS 0
  42. .IP \(bu 2
  43. npm help view
  44. .IP \(bu 2
  45. npm help publish
  46. .IP \(bu 2
  47. npm help registry
  48. .IP \(bu 2
  49. npm help config
  50. .IP \(bu 2
  51. npm help npmrc
  52. .IP \(bu 2
  53. npm help package\.json
  54. .RE