# @node-core/doc-kit 中文文档

规范地址：https://npmcn.com/package/%40node-core/doc-kit/

版本：2\.0\.8
npm 元数据更新时间：2026-11-01T23:05:38.204Z
中文译文更新时间：2026-11-02T00:40:22.314Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40node-core/doc-kit
原文对照：https://npmcn.com/package/%40node-core/doc-kit/?lang=original
源码仓库：https://github.com/nodejs/doc-kit

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：46.3 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2026-03-05T22:47:03.601Z
- 最新版本发布：2026-11-01T23:05:37.845Z
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

用于@doc-kit/core的特定于node .js的生成器：api-links、addon-verify和man-page

## 安装

```sh
npm install @node-core/doc-kit
```

也可以使用：`pnpm add @node-core/doc-kit`、`yarn add @node-core/doc-kit`、`bun add @node-core/doc-kit`

## README

# `@node-core/doc-kit`

的node .js特定的生成器 [doc-kit](https://github.com/nodejs/doc-kit)： Node.js消耗的输出 项目自己的构建、发布和文档过程。如果你不是 构建Node.js本身（或者类似的东西），您可能 想要一个吗？ [通用发电机](https://doc-kit.nodejs.org/) 代替。

## 安装

```sh
npm install --save-dev @doc-kit/core @node-core/doc-kit
```

## 发电机

| 目标 | 输出 |
| --- | --- |
| `man-page` | 这个 `node.1` 手册页中记录的CLI选项 `cli.md`. |
| `api-links` | API符号到它们的源位置的映射，支持nodejs.org上的源链接。 |
| `addon-verify` | 提取的c++插件代码样本 `addons.md`，安排由测试进行编译。 |

## 使用

```sh
npx @doc-kit/cli generate -t man-page -i "doc/api/cli.md" -o out
```

看到 [doc-kit文档](https://doc-kit.nodejs.org/) 用于 配置和完整的生成器引用。

## 常见问题

### @node-core/doc-kit 是什么？

用于@doc-kit/core的特定于node \.js的生成器：api-links、addon-verify和man-page

### 如何安装 @node-core/doc-kit？

在项目目录运行 npm install @node-core/doc-kit，或使用 pnpm add / yarn add / bun add。

### @node-core/doc-kit 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/node-core\_\_doc-kit 是否存在。

### @node-core/doc-kit 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @node-core/doc-kit 可以商用吗？

@node-core/doc-kit 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @node-core/doc-kit 还在维护吗？

最新版本 2\.0\.8 发布于 2026/11/02（1 天前）；至今共发布 31 个版本，其中过去 12 个月发布了 31 个；首次发布于 2026/03/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。