@nodejs/doc-kit 是一个用于生成 Node.js API 文档的工具。请参阅此 issue 以获取更多信息。

doc-kit 也可以创建与 Node.js 无关的网站。查看文档、入门指南和展示。

用法

本地调用：

$ npx doc-kit --help

$ node packages/core/bin/cli.mjs --help

Usage: @nodejs/doc-kit [options] [command]

CLI tool to generate the Node.js API documentation

Options:
  --log-level <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

您必须通过命令行选项或配置文件提供输入和至少一个目标。配置使用 cosmiconfig 自动发现，或者您可以使用 --config-file 显式选择文件。 在未提供必需值的情况下运行 generate 会退出并显示指向帮助输出的错误。

Usage: @nodejs/doc-kit generate [options]

Generate API docs

Options:
  --config-file <path>         Config file
  -i, --input <patterns...>    Input file patterns (glob)
  -t, --target <generator...>  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 <patterns...>       Ignore file patterns (glob)
  -o, --output <directory>     The output directory
  -p, --threads <number>       Number of threads to use (minimum: 1)
  --chunk-size <number>        Number of items to process per worker thread
                               (minimum: 1)
  -v, --version <semver>       Target Node.js version
  -c, --changelog <url>        Changelog URL or path
  --git-ref <ref>              Git ref
  --index <url>                index.md URL or path
  --minify                     Minify?
  --type-map <url>             Type map URL or path
  -h, --help                   display help for command

示例

旧版

要生成与 旧版工具 的 1:1 匹配，请使用 legacy-html、legacy-json、legacy-html-all 和 legacy-json-all 生成器。

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

要生成我们重新设计的文档页面，请使用 html 和 orama-db（用于搜索）生成器。这些生成器位于独立的 @nodejs/doc-kit-generator-react 包中，必须与本包一起安装。

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

[!TIP] 为了使用搜索功能，你_必须_提供输出目录。

npx serve out