@graphql-markdown/formatters

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

Formatter presets for GraphQL-Markdown: Docusaurus, Starlight, Fumadocs, Vocs, HonKit, Hugo, MkDocs, DocFX, mdBook and generic MDX.

原始使用文档
文档目录10 节
  1. Installation
  2. Usage
  3. Supported formatters
  4. Custom formatter
  5. Documentation
  6. Contributing
  7. Add a new formatter
  8. Formatter contract
  9. Testing checklist
  10. License

@graphql-markdown/formatters

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

Framework formatter presets for GraphQL-Markdown.

This package provides ready-to-use formatter presets for popular documentation frameworks, with each formatter in its own package subpath.

Installation

npm install @graphql-markdown/formatters

Usage

Use any formatter in your GraphQL-Markdown configuration:

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

Or programmatically:

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

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

The legacy mdxParser setting still works as a deprecated alias, but new configurations should use formatter.

Supported formatters

Each formatter has its own setup guide:

FrameworkPackage PathDocumentation
Astro Starlight@graphql-markdown/formatters/starlightGuide
DocFX@graphql-markdown/formatters/docfxGuide
Docusaurus@graphql-markdown/formatters/docusaurusGuide
HonKit@graphql-markdown/formatters/honkitGuide
Hugo@graphql-markdown/formatters/hugoGuide
mdBook@graphql-markdown/formatters/mdbookGuide
Generic MDX@graphql-markdown/formatters/mdxGuide
MkDocs@graphql-markdown/formatters/mkdocsGuide
Next.js + Fumadocs@graphql-markdown/formatters/fumadocsGuide
Vocs@graphql-markdown/formatters/vocsGuide

Custom formatter

For frameworks not listed above, create a custom MDX module. See the Integration Guide for the full formatter contract, the formatMDXDetails \r delimiter invariant, and examples of extending a preset.

Documentation

Contributing

Add a new formatter

  1. Create the formatter module at src/<name>/index.ts.
  2. Create documentation at src/<name>/README.md.
  3. Export the formatter from src/index.ts.
  4. Add a package subpath export for ./<name> in package.json under exports.
  5. Add unit tests in tests/unit/<name>/index.test.ts.

Formatter contract

A formatter module exports createMDXFormatter and any subset of the standard formatter functions (formatMDXBadge, formatMDXAdmonition, formatMDXBullet, formatMDXDetails, formatMDXFrontmatter, formatMDXLink, formatMDXNameEntity, formatMDXSpecifiedByLink). Optional exports include mdxDeclaration, mdxExtension, and lifecycle hooks.

See the Integration Guide for the full contract, type signatures, and the formatMDXDetails \r delimiter invariant.

Testing checklist

Add tests that verify:

  1. Each formatter function output for representative inputs.
  2. createMDXFormatter returns all required formatter methods.
  3. Framework-specific behavior and edge cases (for example link extension mapping, frontmatter behavior, empty title fallback).

Run targeted tests while developing:

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

Run package checks before opening a PR:

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

For repository-wide validation:

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

License

GraphQL-Markdown packages are 100% free and open-source, under the MIT license.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest, you'll be creating employment for local families and restoring wildlife habitats.

版本与发布记录

@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 是什么?

Formatter presets for GraphQL-Markdown: Docusaurus, Starlight, Fumadocs, Vocs, HonKit, Hugo, MkDocs, DocFX, mdBook and generic 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 和提交记录判断。