@node-core/doc-kit

@node-core/doc-kit is a tool to generate API documentation of Node.js. See this issue for more information.

Usage

Local invocation:

$ npx doc-kit --help

$ node bin/cli.mjs --help

Usage: @node-core/doc-kit [options] [command]

CLI tool to generate the Node.js API documentation

Options:
  -h, --help          display help for command

Commands:
  generate [options]  Generate API docs
  interactive         Launch guided CLI wizard
  help [command]      display help for command

generate

Usage: @node-core/doc-kit generate [options]

Generate API docs

Options:
  -i, --input <patterns...>  Input file patterns (glob)
  --ignore [patterns...]     Ignore patterns (comma-separated)
  -o, --output <dir>         Output directory
  -p, --threads <number>      (default: "12")
  -v, --version <semver>     Target Node.js version (default: "v22.14.0")
  -c, --changelog <url>      Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
  --git-ref <url>            Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD")
  -t, --target [modes...]    Target generator modes (choices: "json-simple", "legacy-html", "legacy-html-all", "man-page", "legacy-json", "legacy-json-all", "addon-verify", "api-links", "orama-db", "llms-txt")
  -h, --help                 display help for command

interactive

Usage: @node-core/doc-kit interactive [options]

Launch guided CLI wizard

Options:
  -h, --help  display help for command

Examples

Legacy

To generate a 1:1 match with the legacy tooling, use the legacy-html, legacy-json, legacy-html-all, and legacy-json-all generators.

npx doc-kit generate \
  -t legacy-html \
  -t legacy-json \
  -i "path/to/node/doc/api/*.md" \
  -o out \
  --index path/to/node/doc/api/index.md

Redesigned

To generate our redesigned documentation pages, use the web and orama-db (for search) generators.

npx doc-kit generate \
  -t web \
  -t orama-db \
  -i "path/to/node/doc/api/*.md" \
  -o out \
  --index path/to/node/doc/api/index.md

[!TIP] In order to use the search functionality, you must serve the output directory.

npx serve out