@graphql-markdown/formatters

中文文档
1.2.2发布于 2026/11/15MITTypeScriptESM + CJS构建来源已验证近 30 天下载 7.3万

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

中文使用文档
文档目录10 节
  1. 安装
  2. 使用量
  3. 支持的格式符
  4. 自定义处理
  5. 文档
  6. 捐款
  7. 添加新主题
  8. Formaters 合同
  9. 测试清单
  10. 许可证

@ graphql- markdown/ 格式化

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

事务预设框架 图QL- 马可达。 。 。 .

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

安装

npm install @graphql-markdown/formatters

使用量

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

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

或在方案方面:

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指南
文档FX@graphql-markdown/formatters/docfx指南
多龙@graphql-markdown/formatters/docusaurus指南
亲爱的@graphql-markdown/formatters/honkit指南
乌戈@graphql-markdown/formatters/hugo指南
微书@graphql-markdown/formatters/mdbook指南
常规 MDX@graphql-markdown/formatters/mdx指南
麦克风@graphql-markdown/formatters/mkdocs指南
下一个.js + Fumadocs@graphql-markdown/formatters/fumadocs指南
声音@graphql-markdown/formatters/vocs指南

自定义处理

对于上面没有列出的框架,创建自定义的MDX模块. 见 融合指南 全部物料合同 formatMDXDetails \r 指定词不变量,以及扩展预设的例子.

文档

捐款

添加新主题

  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和生命周期钩.

见 融合指南 合同全文、类型签名和 formatMDXDetails \r 划界者无常.

测试清单

添加验证测试 :

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

开发目标测试时:

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

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

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

全库验证:

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

许可证

GraphQL-Markdown 软件包是100%的自由和开源软件,在 麻省理工学院许可证。 。 。 .

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

版本与发布记录

@graphql-markdown/formatters 共发布 10 个版本,首次发布于 2026/05/31;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.2.2latest2026/11/151 天前
1.2.12026/10/3018 天前
1.2.02026/10/131 个月前
1.1.32026/10/101 个月前
1.1.22026/10/091 个月前
1.1.12026/09/181 个月前

关于 @graphql-markdown/formatters 的常见问题

@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 和提交记录判断。