search

nodejs / api-docs-tooling

Node.js's tooling for API generation
https://nodejs.org/api
MIT License
5 stars 5 forks source link

readme


Node.js Logo

api-docs-tooling is a tool to generate API documentation of Node.js. See this issue for more information.

MIT License api-docs-tooling scorecard badge

## Usage Local invocation: ```sh $ npx api-docs-tooling --help ``` ```sh Usage: api-docs-tooling [options] CLI tool to generate API documentation of a Node.js project. Options: -i, --input [patterns...] Specify input file patterns using glob syntax -o, --output Specify the relative or absolute output directory -v, --version Specify the target version of Node.js, semver compliant (default: "v22.6.0") -c, --changelog Specify the path (file: or https://) to the CHANGELOG.md file (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md") -t, --target [mode...] Set the processing target modes (choices: "json-simple", "legacy-html", "legacy-html-all", "man-page", "legacy-json", "legacy-json-all") -h, --help display help for command ```