step-security-bot/api-docs-tooling · GitHub

Name		Name	Last commit message	Last commit date
.github		.github
.husky		.husky
bin		bin
src		src
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.lintstagedrc.json		.lintstagedrc.json
.nvmrc		.nvmrc
.prettierrc.json		.prettierrc.json
CODEOWNERS		CODEOWNERS
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
eslint.config.mjs		eslint.config.mjs
package-lock.json		package-lock.json
package.json		package.json
shiki.config.mjs		shiki.config.mjs

Repository files navigation

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

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")
  -h, --help                 display help for command