# @graphql-markdown/formatters 中文文档

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

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

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

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

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

- 包体积（解压后）：160 kB，44 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：3 个
- 首次发布：2026-05-31T15:49:53.523Z
- 最新版本发布：2026-11-15T09:26:15.767Z
- 近 30 天下载量：73316（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

用于GraphQL-Markdown的材料预设:多克龙、星光、Fumadocs、Vocs、HonKit、Hugo、MkDocs、DocFX、mdBook和通用MDX.

## 安装

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

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

## README

# @ graphql- markdown/ 格式化

[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/formatters?style=flat)](https://www.npmjs.com/package/@graphql-markdown/formatters) [![JSR](https://jsr.io/badges/@graphql-markdown/formatters)](https://jsr.io/@graphql-markdown/formatters) [![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_formatters&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=graphql-markdown_formatters) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=graphql-markdown_formatters&metric=coverage)](https://sonarcloud.io/summary/new_code?id=graphql-markdown_formatters) [![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%3Dformatters)](https://dashboard.stryker-mutator.io/reports/github.com/graphql-markdown/graphql-markdown/main?module=formatters)

事务预设框架 [图QL- 马可达](https://graphql-markdown.dev/)。 。 。 .

该套件为通俗文献框架提供现成的物料预设,每个物料都在自己的套件子路径中.

## 安装

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

## 使用量

使用您的 GraphQL- Markdown 配置中的任何预设 :

```yaml
schema: ./schema.graphql
extensions:
  graphql-markdown:
    rootPath: ./docs
    baseURL: api
    formatter: "@graphql-markdown/formatters/docusaurus"
```

或在方案方面:

```ts
import { runGraphQLMarkdown } from "@graphql-markdown/cli";

await runGraphQLMarkdown({
  schema: "./schema.graphql",
  rootPath: "./docs",
  baseURL: "api",
  formatter: "@graphql-markdown/formatters/docusaurus",
});
```

遗产 `mdxParser` 设置仍然作为已贬值的别名起作用,但新配置应当使用 `formatter`。 。 。 .

## 支持的格式符

每个论坛都有自己的设置指南:

| 框架 | 软件包路径 | 文档 |
| --- | --- | --- |
| 天体星光 | `@graphql-markdown/formatters/starlight` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/starlight/README.md) |
| 文档FX | `@graphql-markdown/formatters/docfx` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/docfx/README.md) |
| 多龙 | `@graphql-markdown/formatters/docusaurus` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/docusaurus/README.md) |
| 亲爱的 | `@graphql-markdown/formatters/honkit` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/honkit/README.md) |
| 乌戈 | `@graphql-markdown/formatters/hugo` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/hugo/README.md) |
| 微书 | `@graphql-markdown/formatters/mdbook` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/mdbook/README.md) |
| 常规 MDX | `@graphql-markdown/formatters/mdx` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/mdx/README.md) |
| 麦克风 | `@graphql-markdown/formatters/mkdocs` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/mkdocs/README.md) |
| 下一个.js + Fumadocs | `@graphql-markdown/formatters/fumadocs` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/fumadocs/README.md) |
| 声音 | `@graphql-markdown/formatters/vocs` | [指南](https://npmcn.com/package/%40graphql-markdown/formatters/src/vocs/README.md) |

## 自定义处理

对于上面没有列出的框架,创建自定义的MDX模块. 见 [融合指南](https://graphql-markdown.dev/docs/advanced/integration-with-frameworks#custom-mdx-formatter) 全部物料合同 `formatMDXDetails` `\r` 指定词不变量,以及扩展预设的例子.

## 文档

-   [与框架的整合](https://graphql-markdown.dev/docs/advanced/integration-with-frameworks)
-   [配置选项](https://graphql-markdown.dev/docs/settings)

## 捐款

### 添加新主题

1.  在 `src/<name>/index.ts`。 。 。 .
2.  创建文档于 `src/<name>/README.md`。 。 。 .
3.  导出前题 `src/index.ts`。 。 。 .
4.  添加包子路径导出 `./<name>` 内 `package.json` 下级 `exports`。 。 。 .
5.  在其中添加单位测试 `tests/unit/<name>/index.test.ts`。 。 。 .

### Formaters 合同

一个 formatter 模块导出 `createMDXFormatter` 和任何关于物质函数的标准子集(`formatMDXBadge`, (中文(简体) ), `formatMDXAdmonition`, (中文(简体) ), `formatMDXBullet`, (中文(简体) ), `formatMDXDetails`, (中文(简体) ), `formatMDXFrontmatter`, (中文(简体) ), `formatMDXLink`, (中文(简体) ), `formatMDXNameEntity`, (中文(简体) ), `formatMDXSpecifiedByLink`) (中文(简体) ). 可选出口包括: `mdxDeclaration`, (中文(简体) ), `mdxExtension`和生命周期钩.

见 [融合指南](https://graphql-markdown.dev/docs/advanced/integration-with-frameworks#custom-mdx-formatter) 合同全文、类型签名和 `formatMDXDetails` `\r` 划界者无常.

### 测试清单

添加验证测试 :

1.  用于代表性投入的每个格式函数输出.
2.  `createMDXFormatter` 返回所有需要的材料方法.
3.  框架特定的行为和边缘案例(例如链接扩展映射,前事行为,空标题倒置等).

开发目标测试时:

```shell
cd packages/formatters
bun run test:unit -- tests/unit/<name>/index.test.ts
```

在打开 PR 之前运行套件检查 :

```shell
cd packages/formatters
bun run lint
bun run prettier
bun run test:unit
```

全库验证:

```shell
cd /path/to/graphql-markdown
bun run test
```

## 许可证

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/formatters 是什么？

用于GraphQL-Markdown的材料预设:多克龙、星光、Fumadocs、Vocs、HonKit、Hugo、MkDocs、DocFX、mdBook和通用MDX\.

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

在项目目录运行 npm install @graphql-markdown/formatters，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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

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

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

