Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.72 KB

README.md

File metadata and controls

44 lines (36 loc) · 1.72 KB
Raw


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:

$ npx api-docs-tooling --help
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 <path>        Specify the relative or absolute output directory
  -v, --version <semver>     Specify the target version of Node.js, semver compliant (default: "v22.6.0")
  -c, --changelog <url>      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