How it works
1
Set up
Run the create command for a new site, or install the package in the docs project you already have.
2
Configure
Point it at your schema: SDL files, an introspection endpoint, GraphQL Config, or a code-first TS/JS schema.
3
Generate
Run the CLI to get Markdown or MDX pages, ready for your docs site.
Why GraphQL-Markdown?
Schema to docs in one command
Get a page for every type, query, mutation, and subscription in your schema.
- Cross-linked types
- Deprecation notices
- Custom directive badges
Output adapted for your docs ecosystem
Generate Markdown or MDX. Formatter presets follow the conventions of Docusaurus, Nuxt, Hugo, MkDocs, and other targets.
Explore formatter presets →Free and open-source
MIT licensed and actively maintained. If it saves you time, consider planting a tree.
View on GitHub →
