|
23 | 23 |
|
24 | 24 | ## Usage |
25 | 25 |
|
26 | | -### `help` |
27 | | - |
28 | | -```sh |
29 | | -npx api-docs-tooling help [command] |
30 | | -``` |
31 | | - |
32 | | -### `generate` |
33 | | - |
34 | | -Generate API documentation from Markdown files. |
35 | | - |
36 | | -```sh |
37 | | -npx api-docs-tooling generate [options] |
38 | | -``` |
39 | | - |
40 | | -**Options:** |
41 | | - |
42 | | -- `-i, --input <patterns...>` Input file patterns (glob) |
43 | | -- `--ignore [patterns...]` Files to ignore |
44 | | -- `-o, --output <dir>` Output directory |
45 | | -- `-v, --version <semver>` Target Node.js version (default: latest) |
46 | | -- `-c, --changelog <url>` Changelog file or URL |
47 | | -- `--git-ref <url>` Git ref/commit URL |
48 | | -- `-t, --target [modes...]` Generator target(s): `json-simple`, `legacy-html`, etc. |
49 | | -- `--no-lint` Skip linting before generation |
50 | | - |
51 | | -### `lint` |
52 | | - |
53 | | -Run the linter on API documentation. |
54 | | - |
55 | | -```sh |
56 | | -npx api-docs-tooling lint [options] |
57 | 26 | ``` |
| 27 | +Usage: api-docs-tooling [options] [command] |
58 | 28 |
|
59 | | -**Options:** |
60 | | - |
61 | | -- `-i, --input <patterns...>` Input file patterns (glob) |
62 | | -- `--ignore [patterns...]` Files to ignore |
63 | | -- `--disable-rule [rules...]` Disable specific linting rules |
64 | | -- `--dry-run` Run linter without applying changes |
65 | | -- `-r, --reporter <reporter>` Reporter format: `console`, `github`, etc. |
| 29 | +CLI tool to generate and lint Node.js API documentation |
66 | 30 |
|
67 | | -### `interactive` |
| 31 | +Options: |
| 32 | + -h, --help display help for command |
68 | 33 |
|
69 | | -Launches a fully interactive CLI prompt to guide you through all available options. |
70 | | - |
71 | | -```sh |
72 | | -npx api-docs-tooling interactive |
73 | | -``` |
74 | | - |
75 | | -### `list` |
76 | | - |
77 | | -See available modules for each subsystem. |
78 | | - |
79 | | -```sh |
80 | | -npx api-docs-tooling list generators |
81 | | -npx api-docs-tooling list rules |
82 | | -npx api-docs-tooling list reporters |
83 | | -``` |
| 34 | +Commands: |
| 35 | + generate [options] Generate API docs |
| 36 | + lint [options] Run linter independently |
| 37 | + interactive Launch guided CLI wizard |
| 38 | + list <types> List the given type |
| 39 | + help [command] display help for command |
| 40 | +``` |
0 commit comments