Skip to content

nodejs/api-docs-tooling

Folders and files

NameName
Last commit message
Last commit date
Mar 7, 2025
Jun 10, 2024
Mar 14, 2025
Mar 14, 2025
Jun 10, 2024
May 14, 2024
Jan 20, 2025
Jun 10, 2024
Aug 8, 2024
Jun 10, 2024
May 14, 2024
May 14, 2024
May 14, 2024
Mar 10, 2025
Nov 24, 2024
Mar 19, 2025
Mar 19, 2025
Mar 5, 2025

Repository files navigation


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
  --ignore [patterns...]     Specify files to be ignored from the input 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", "addon-verify", "api-links")
  -h, --help                 display help for command