@node-core/doc-kit

中文文档
2.0.8发布于 2026/11/02MITES Module构建来源已验证

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

中文使用文档
文档目录3 节
  1. 安装
  2. 发电机
  3. 使用

@node-core/doc-kit

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

安装

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

发电机

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

使用

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

看到 doc-kit文档 用于 配置和完整的生成器引用。

版本与发布记录

@node-core/doc-kit 共发布 31 个版本,首次发布于 2026/03/06;过去 12 个月发布了 31 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.8latest2026/11/021 天前
2.0.72026/10/312 天前
2.0.62026/10/1320 天前
2.0.52026/10/0429 天前
2.0.42026/10/011 个月前
2.0.32026/09/231 个月前

关于 @node-core/doc-kit 的常见问题

@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 和提交记录判断。