@graphql-markdown/docusaurus

Docusaurus docs feature plugin for generating Markdown documentation from a GraphQL schema.
Installation
npm init docusaurus my-website https://github.com/graphql-markdown/template.git
If you already have an existing Docusaurus installation, then see the documentation for an alternative installation.
Usage
The plugin adds a new command graphql-to-doc
to the Docusaurus CLI.
npx docusaurus graphql-to-doc
Command line options are described in the documentation settings page.
Configuration
See documentation settings page.
Troubleshooting
See documentation troubleshooting page.
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.
1.29.1 - 2025-06-15
🐛 This release adds better support of special characters (e.g. _
) in entity names, fixing issues like #2213 reported by @PaulRBerg.
📄 The documentation has also got its share of fixes, thanks to @PaulRBerg reports.
What's Changed
- :memo: more doc update in #2065
- :bug: fix mdx compilation error when underscore used with entity name in #2215
- :memo: fix pretty param in config docs in #2220
- :memo: fix incorrect use of customDirective in example in #2221
- :memo: add troubleshooting info linked to #2213 in #2216
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.29.0...1.29.1
[Changes][1.29.1]
<a id="1.29.0"></a>