@@ -46,14 +46,21 @@ $ node packages/core/bin/cli.mjs --help
4646```
4747Usage: @nodejs/doc-kit [options] [command]
4848
49- CLI tool to generate the Node.js API documentation
49+ CLI tool to generate API documentation
5050
5151Options:
52- -h, --help display help for command
52+ --log-level <level> Log level (choices: "debug", "info",
53+ "warn", "error", "fatal", default: "info")
54+ -h, --help display help for command
5355
5456Commands:
55- generate [options] Generate API docs
56- help [command] display help for command
57+ generate [options] Generate API docs
58+ install [options] [generators...] Install the packages providing built-in
59+ generators (defaults to the targets in your
60+ configuration file)
61+ serve [options] Generate API docs, serve them locally, and
62+ regenerate on changes
63+ help [command] display help for command
5764```
5865
5966### ` generate `
@@ -70,15 +77,37 @@ Usage: @nodejs/doc-kit generate [options]
7077Generate API docs
7178
7279Options:
73- -i, --input <patterns...> Input file patterns (glob)
74- --ignore [patterns...] Ignore patterns (comma-separated)
75- -o, --output <dir> Output directory
76- -p, --threads <number> (default: "12")
77- -v, --version <semver> Target Node.js version (default: "v22.14.0")
78- -c, --changelog <url> Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md")
79- --git-ref <url> Git ref/commit URL (default: "https://github.com/nodejs/node/tree/HEAD")
80- -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")
81- -h, --help display help for command
80+ --config-file <path> Config file
81+ -i, --input <patterns...> Input file patterns (glob)
82+ -t, --target <generator...> Target generator(s): a built-in name
83+ (json-simple, legacy-html, legacy-html-all,
84+ man-page, legacy-json, legacy-json-all,
85+ addon-verify, api-links, orama-db, llms-txt,
86+ sitemap, html) or an import specifier for a
87+ custom generator
88+ --ignore <patterns...> Ignore file patterns (glob)
89+ -o, --output <directory> The output directory
90+ -p, --threads <number> Number of threads to use (minimum: 1)
91+ --chunk-size <number> Number of items to process per worker thread
92+ (minimum: 1)
93+ -v, --version <semver> Target project version
94+ -c, --changelog <url> Changelog URL or path
95+ --git-ref Git ref URL
96+ --index <url> index.md URL or path
97+ --minify Minify?
98+ --type-map <url> Type map URL or path
99+ -h, --help display help for command
100+ ```
101+
102+ The defaults are project-neutral. To produce output styled and structured the
103+ way [ nodejs.org] ( https://nodejs.org ) builds its API docs, extend the Node.js
104+ preset in your configuration file — see
105+ [ the configuration guide] ( docs/configuration.md#extending-presets ) :
106+
107+ ``` mjs
108+ export default {
109+ extends: ' @node-core/doc-kit/config' ,
110+ };
82111```
83112
84113### ` install `
0 commit comments