Flexible documentation for GraphQL schemas

GraphQL-Markdown

Generate Markdown and MDX documentation from GraphQL schemas for Docusaurus and other supported documentation ecosystems.

Installation

GraphQL-Markdown supports two main setup paths:

• use the official Docusaurus integration for Docusaurus sites
• use the CLI with formatter presets for other supported ecosystems such as Hugo, MkDocs, DocFX, and mdBook

# For Docusaurus sites
npm install @graphql-markdown/docusaurus graphql
For formatter-based setups
npm install @graphql-markdown/cli @graphql-markdown/formatters graphql

Usage

Docusaurus Plugin

Add to your docusaurus.config.js:

module.exports = {
  plugins: ["@graphql-markdown/docusaurus"],
};

Run the generation command:

npx docusaurus graphql-to-doc

CLI Usage

Use the CLI directly for custom workflows, or pair it with @graphql-markdown/formatters to adapt the generated output for supported frameworks.

npx gqlmd graphql-to-doc --schema ./schema.graphql --root ./docs

For formatter-based setups:

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

API Usage

For programmatic usage, you can use the CLI package:

import { runGraphQLMarkdown } from '@graphql-markdown/cli';
const config = {
  schema: './schema.graphql',
  rootPath: './docs',
};
await runGraphQLMarkdown(config);