# @doc-kit/generator-react 中文文档

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

版本：0\.5\.3
npm 元数据更新时间：2026-11-01T23:05:37.637Z
中文译文更新时间：2026-11-12T13:41:43.496Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：261 kB，104 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：31 个
- 首次发布：2026-08-10T13:41:30.037Z
- 最新版本发布：2026-11-01T23:05:37.280Z
- 近 30 天下载量：9022（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

基于 @doc- kit/ core的响应/ JSX 生成器: html, jsx- ast, llms- txt, llms- txt- full, sitemap, 和 orama- db

## 安装

```sh
npm install @doc-kit/generator-react
```

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

## README

# `@doc-kit/generator-react`

现代网络生成器 [医生](https://github.com/nodejs/doc-kit)数字 : 服务器上的客户端水合文件网站,加上 通常随同一种的机器可读格式.

## 安装

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

## 发电机

| 目标 | 产出 |
| --- | --- |
| `html` | 完整的文档站点——服务器发送的页面与Preact水分,与Vite捆绑. |
| `orama-db` | 一个 [奥拉玛](https://orama.com/) 搜索索引,按 `html` 网站的搜索框. |
| `llms-txt` | 一个 [`llms.txt`](https://llmstxt.org/) 大语言模型索引. |
| `llms-txt-full` | 每一页的马克下在一个 `llms-full.txt`,用于大语言模型. |
| `sitemap` | A 类 `sitemap.xml` 为搜索引擎. |
| `section-pages` | 这个 `html` 站点和站点地图,每个模块每节加一页. |

该套件还提供了 `jsx-ast`的中间相 API 元数据输入JSX;当 `html` 需要它而不是一个 目标你援引自己.

## 使用量

```sh
npx @doc-kit/cli generate -t html -t orama-db -i "docs/**/*.md" -o out
```

这个 `html` 生成器非常定制——项目名称、页面标题、, `<head>` 标记、侧边栏和导航栏、主题组件,甚至 捆绑者都是配置的. 见 [`html` 发电机 参考文献](https://doc-kit.nodejs.org/generators/html) 编辑 [doc-kit 文档](https://doc-kit.nodejs.org/) 全文 选项.

## 常见问题

### @doc-kit/generator-react 是什么？

基于 @doc- kit/ core的响应/ JSX 生成器: html, jsx- ast, llms- txt, llms- txt- full, sitemap, 和 orama- db

### 如何安装 @doc-kit/generator-react？

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

### @doc-kit/generator-react 支持 TypeScript 吗？

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

### @doc-kit/generator-react 支持 ESM 还是 CommonJS？

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

### @doc-kit/generator-react 可以商用吗？

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

### @doc-kit/generator-react 的下载量有多少？

根据 npm 官方下载统计，@doc-kit/generator-react 在 2026/10/13 – 2026/11/11 这 30 天内被下载 9,022 次，日均约 301 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @doc-kit/generator-react 还在维护吗？

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