# @graphql-markdown/helpers 中文文档

规范地址：https://npmcn.com/package/%40graphql-markdown/helpers/

版本：1\.2\.5
npm 元数据更新时间：2026-11-15T09:26:10.914Z
中文译文更新时间：2026-11-16T23:04:33.585Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40graphql-markdown/helpers
原文对照：https://npmcn.com/package/%40graphql-markdown/helpers/?lang=original
项目主页：https://graphql-markdown.dev/
源码仓库：https://github.com/graphql-markdown/graphql-markdown

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

- 包体积（解压后）：36.7 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：3 个
- peer 依赖：graphql ^16\.0\.0 \|\| ^17\.0\.0
- 首次发布：2023-08-21T14:58:59.619Z
- 最新版本发布：2026-11-15T09:26:10.513Z
- 近 30 天下载量：73710（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 11 个）

## 中文简介

用于自定义GraphQL-Markdown输出的助手,例如指令和自定义渲染.

## 安装

```sh
npm install @graphql-markdown/helpers
```

也可以使用：`pnpm add @graphql-markdown/helpers`、`yarn add @graphql-markdown/helpers`、`bun add @graphql-markdown/helpers`

## README

# @ graphql- markdown/ 帮助

[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/helpers?style=flat)](https://www.npmjs.com/package/@graphql-markdown/helpers) [![JSR](https://jsr.io/badges/@graphql-markdown/helpers)](https://jsr.io/@graphql-markdown/helpers) [![GitHub License](https://img.shields.io/github/license/graphql-markdown/graphql-markdown?style=flat)](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=graphql-markdown_helpers&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=graphql-markdown_helpers) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=graphql-markdown_helpers&metric=coverage)](https://sonarcloud.io/summary/new_code?id=graphql-markdown_helpers) [![Mutation Score](https://img.shields.io/endpoint?label=mutation%20score&style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fgraphql-markdown%2Fgraphql-markdown%2Fmain%3Fmodule%3Dhelpers)](https://dashboard.stryker-mutator.io/reports/github.com/graphql-markdown/graphql-markdown/main?module=helpers)

用于自定义 GraphQL-Markdown 输出的可重复使用的帮助器:从 schema 指令中提供自定义描述和徽章,基于布线指令的装饰器,以及用于预设的共享 Markdown 格式化的公用设备.

## 安装

```shell
npm install @graphql-markdown/helpers
```

## 使用量

### 自定义指令描述

```js
import { directiveDescriptor } from "@graphql-markdown/helpers";

// customDirective.version.descriptor in your GraphQL-Config
export default (directive, type) =>
  directiveDescriptor(
    directive,
    type,
    "${description} is ${major}.${minor}.${patch}",
  );
```

### 自定义指令徽章

```js
import { directiveTag } from "@graphql-markdown/helpers";

// customDirective.auth.tag in your GraphQL-Config
export default (directive, type) =>
  directiveTag(directive, type, "badge--warning");
```

### 基于指令的装饰器

```ts
import { withDirective } from "@graphql-markdown/helpers";

const decorator = withDirective("deprecated", (directive, options, context) => {
  // render decorator content derived from the directive's definition
});
```

## 文档

-   [自定义指令](https://graphql-markdown.dev/docs/advanced/custom-directive)
-   [装饰者](https://graphql-markdown.dev/docs/advanced/decorators)

## 许可证

GraphQL-Markdown 软件包是100%的自由和开源软件,在 [麻省理工学院许可证](https://github.com/graphql-markdown/graphql-markdown/blob/main/LICENSE)。 。 。 .

这个软件包是 [树件](https://treeware.earth/)如果你把它用于生产,那么我们要求你 [**给世界买一棵树**](https://plant.treeware.earth/graphql-markdown/graphql-markdown) 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.

## 常见问题

### @graphql-markdown/helpers 是什么？

用于自定义GraphQL-Markdown输出的助手,例如指令和自定义渲染\.

### 如何安装 @graphql-markdown/helpers？

在项目目录运行 npm install @graphql-markdown/helpers，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（^16\.0\.0 \|\| ^17\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @graphql-markdown/helpers 支持 TypeScript 吗？

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

### @graphql-markdown/helpers 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @graphql-markdown/helpers 需要什么版本的 Node\.js？

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

### @graphql-markdown/helpers 可以商用吗？

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

### @graphql-markdown/helpers 的下载量有多少？

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

### @graphql-markdown/helpers 还在维护吗？

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

