Shared OG image generation, docs config helper, and QA tooling for Starlight sites.
Install: "@elcoosp/docs-toolkit": "github:elcoosp/docs-toolkit#<sha>"
astro.config.mjs:
import { defineDocsConfig } from '@elcoosp/docs-toolkit/config';
export default await defineDocsConfig({ site, domain, title, description, plugins, sidebar });
src/routeData.mjs:
export { onRequest } from '@elcoosp/docs-toolkit/og/routeData';
Features: auto-derived accent, per-page OG PNGs, section badges, config wrapper with extraStarlight/extraIntegrations/extraVite/accentOverride hooks.
关于 @elcoosp/docs-toolkit 的常见问题
@elcoosp/docs-toolkit 是什么？
Shared OG image generation, docs config helper, and QA tooling for Starlight sites
如何安装 @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 和提交记录判断。