diff --git a/README.md b/README.md index e520eb6f..1bcadb89 100644 --- a/README.md +++ b/README.md @@ -49,11 +49,13 @@ Usage: @node-core/doc-kit [options] [command] CLI tool to generate the Node.js API documentation Options: - -h, --help display help for command + --log-level Log level (choices: "debug", "info", "warn", "error", + "fatal", default: "info") + -h, --help display help for command Commands: - generate [options] Generate API docs - help [command] display help for command + generate [options] Generate API docs + help [command] display help for command ``` ### `generate` @@ -70,15 +72,26 @@ Usage: @node-core/doc-kit generate [options] Generate API docs Options: - -i, --input Input file patterns (glob) - --ignore [patterns...] Ignore patterns (comma-separated) - -o, --output Output directory - -p, --threads (default: "12") - -v, --version Target Node.js version (default: "v22.14.0") - -c, --changelog Changelog URL or path (default: "https://raw.githubusercontent.com/nodejs/node/HEAD/CHANGELOG.md") - --git-ref 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 + --config-file Config file + -i, --input Input file patterns (glob) + -t, --target Target generator(s): a built-in name + (json-simple, legacy-html, legacy-html-all, + man-page, legacy-json, legacy-json-all, + addon-verify, api-links, orama-db, llms-txt, + sitemap, web) or an import specifier for a custom + generator + --ignore Ignore file patterns (glob) + -o, --output The output directory + -p, --threads Number of threads to use (minimum: 1) + --chunk-size Number of items to process per worker thread + (minimum: 1) + -v, --version Target Node.js version + -c, --changelog Changelog URL or path + --git-ref Git ref + --index index.md URL or path + --minify Minify? + --type-map Type map URL or path + -h, --help display help for command ``` ## Examples diff --git a/packages/core/bin/commands/generate.mjs b/packages/core/bin/commands/generate.mjs index 90e8c9d3..69dc6f23 100644 --- a/packages/core/bin/commands/generate.mjs +++ b/packages/core/bin/commands/generate.mjs @@ -61,7 +61,7 @@ export default new Command('generate') ) .addOption(new Option('-v, --version ', 'Target Node.js version')) .addOption(new Option('-c, --changelog ', 'Changelog URL or path')) - .addOption(new Option('--git-ref', 'Git ref URL')) + .addOption(new Option('--git-ref ', 'Git ref')) .addOption(new Option('--index ', 'index.md URL or path')) .addOption(new Option('--minify', 'Minify?')) .addOption(new Option('--type-map ', 'Type map URL or path'))