File tree Expand file tree Collapse file tree 1 file changed +24
-0
lines changed
Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change 2020 <img src="https://api.securityscorecards.dev/projects/github.com/nodejs/api-docs-tooling/badge" alt="api-docs-tooling scorecard badge" />
2121 </a >
2222</p >
23+
24+ ## Usage
25+
26+ Local invocation:
27+
28+ ``` sh
29+ $ npx api-docs-tooling --help
30+ ```
31+
32+ ``` sh
33+ Usage: api-docs-tooling [options]
34+
35+ CLI tool to generate API documentation of a Node.js project.
36+
37+ Options:
38+ -i, --input [patterns...] Specify input file patterns using glob syntax
39+ -o, --output < path> Specify the relative or absolute output directory
40+ -v, --version < semver> Specify the target version of Node.js, semver compliant (default: " v22.6.0" )
41+ -c, --changelog < url> Specify the path (file: or https://) to the CHANGELOG.md file (default:
42+ " https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md" )
43+ -t, --target [mode...] Set the processing target modes (choices: " json-simple" , " legacy-html" ,
44+ " legacy-html-all" )
45+ -h, --help display help for command
46+ ```
You can’t perform that action at this time.
0 commit comments