@graphql-markdown/formatters

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

Quick Start

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:

| Framework | Package Path | Documentation | | --------- | ------------ | ------------- | | Astro Starlight | @graphql-markdown/formatters/starlight | Guide | | DocFX | @graphql-markdown/formatters/docfx | Guide | | Docusaurus | @graphql-markdown/formatters/docusaurus | Guide | | HonKit | @graphql-markdown/formatters/honkit | Guide | | Hugo | @graphql-markdown/formatters/hugo | Guide | | mdBook | @graphql-markdown/formatters/mdbook | Guide | | MkDocs | @graphql-markdown/formatters/mkdocs | Guide | | Next.js + Fumadocs | @graphql-markdown/formatters/fumadocs | Guide | | Vocs | @graphql-markdown/formatters/vocs | Guide |

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.

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