diff options
| author | isaacs <i@izs.me> | 2021-05-13 23:46:30 +0300 |
|---|---|---|
| committer | Gar <gar+gh@danger.computer> | 2021-05-14 18:39:54 +0300 |
| commit | 2f5c28a68719e948d2efedf463ebcb35972aaefb (patch) | |
| tree | 69b3c3d7aa81decaaccbe4c11831f16f12301180 /docs/content/commands/npm-help.md | |
| parent | 3bd758387f0f4668ae1eb2bfe420051da2a74c8e (diff) | |
fix(docs): autogenerate config docs for commands
Add a script and Makefile rule to build the "Configuration" section for
all command documentation based on the command classes' `params` list.
Also correct several minor problems in the documentation, and add
`params` listings for commands that were lacking them, to match the
existing documentation and/or behavior within the code.
PR-URL: https://github.com/npm/cli/pull/3243
Credit: @isaacs
Close: #3243
Reviewed-by: @wraithgar
Diffstat (limited to 'docs/content/commands/npm-help.md')
| -rw-r--r-- | docs/content/commands/npm-help.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/content/commands/npm-help.md b/docs/content/commands/npm-help.md index 57c5efc8e..81f55db33 100644 --- a/docs/content/commands/npm-help.md +++ b/docs/content/commands/npm-help.md @@ -23,15 +23,19 @@ topic, so unique matches are equivalent to specifying a topic name. ### Configuration -#### viewer +<!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> +<!-- automatically generated, do not edit manually --> +#### `viewer` * Default: "man" on Posix, "browser" on Windows -* Type: path +* Type: String The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. +<!-- AUTOGENERATED CONFIG DESCRIPTIONS END --> + ### See Also * [npm](/commands/npm) |