# @elcoosp/docs-toolkit 中文文档

规范地址：https://npmcn.com/package/%40elcoosp/docs-toolkit/

版本：0\.5\.37
npm 元数据更新时间：2026-11-13T14:16:08.753Z
中文译文更新时间：2026-11-13T11:42:28.207Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40elcoosp/docs-toolkit
原文对照：https://npmcn.com/package/%40elcoosp/docs-toolkit/?lang=original
项目主页：https://github.com/elcoosp/docs-toolkit#readme
源码仓库：https://github.com/elcoosp/docs-toolkit

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

- 包体积（解压后）：241 kB，63 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：19 个
- peer 依赖：astro ^7\.0\.0，react ^19\.3\.1，mermaid ^11\.0\.0，playwright ^1\.65\.0，astro-takumi \*，@astrojs/starlight ^0\.42\.0
- 首次发布：2026-11-11T20:30:49.300Z
- 最新版本发布：2026-11-13T14:16:08.515Z
- 近 30 天下载量：4151（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

共享 OG 图像生成、 Docs 配置助手和星光站点QA 工具

## 安装

```sh
npm install @elcoosp/docs-toolkit
```

也可以使用：`pnpm add @elcoosp/docs-toolkit`、`yarn add @elcoosp/docs-toolkit`、`bun add @elcoosp/docs-toolkit`

## README

# @elcoosp/docs-toolkit (英语)

共享 OG 图像生成, Docs 配置帮助器, 为星光站点提供QA 工具.

安装 : `"@elcoosp/docs-toolkit": "github:elcoosp/docs-toolkit#<sha>"`

astro.config.mjs: (英语)

```js
import { defineDocsConfig } from '@elcoosp/docs-toolkit/config';
export default await defineDocsConfig({ site, domain, title, description, plugins, sidebar });
```

src/ routeData.mjs: (中文(简体) )

```js
export { onRequest } from '@elcoosp/docs-toolkit/og/routeData';
```

特征:自发出自口音,每页OG PNG,区徽,配置包装有: `extraStarlight`编号 :`extraIntegrations`编号 :`extraVite`编号 :`accentOverride` 钩子.

## 常见问题

### @elcoosp/docs-toolkit 是什么？

共享 OG 图像生成、 Docs 配置助手和星光站点QA 工具

### 如何安装 @elcoosp/docs-toolkit？

在项目目录运行 npm install @elcoosp/docs-toolkit，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：astro（^7\.0\.0）、react（^19\.3\.1）、mermaid（^11\.0\.0）、astro-takumi（\*）、@astrojs/starlight（^0\.42\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 docs-toolkit-qa-components、docs-toolkit-qa-screenshots、docs-toolkit-bootstrap-artifacts，可以用 npx docs-toolkit-qa-components 直接运行。

### @elcoosp/docs-toolkit 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @elcoosp/docs-toolkit 支持 ESM 还是 CommonJS？

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

### @elcoosp/docs-toolkit 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.18\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @elcoosp/docs-toolkit 可以商用吗？

@elcoosp/docs-toolkit 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @elcoosp/docs-toolkit 的下载量有多少？

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

### @elcoosp/docs-toolkit 还在维护吗？

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