GitHub
github.com › zhouzi › docusaurus-graphql-plugin
GitHub - zhouzi/docusaurus-graphql-plugin: Docusaurus plugin generating Markdown documentation from a GraphQL schema. · GitHub
Docusaurus plugin generating Markdown documentation from a GraphQL schema. - zhouzi/docusaurus-graphql-plugin
Starred by 26 users
Forked by 9 users
Languages: TypeScript 97.9% | JavaScript 2.1%
» npm install @graphql-markdown/docusaurus
Published: Apr 10, 2026
Version: 1.34.0
npm
npmjs.com › package › docusaurus-graphql-plugin
docusaurus-graphql-plugin - npm
November 8, 2022 - Docusaurus plugin generating Markdown documentation from a GraphQL schema.. Latest version: 0.9.0, last published: 3 years ago. Start using docusaurus-graphql-plugin in your project by running `npm i docusaurus-graphql-plugin`. There are 1 other ...
» npm install docusaurus-graphql-plugin
Published: Apr 16, 2023
Version: 0.9.0
npm
npmjs.com › package › @edno › docusaurus2-graphql-doc-generator
@edno/docusaurus2-graphql-doc-generator - npm
This plugin generates a Markdown documentation from a GraphQL schema. The documentation is generated for Docusaurus docs feature.
» npm install @edno/docusaurus2-graphql-doc-generator
Published: Sep 04, 2022
Version: 1.13.1
GraphQL-Markdown
graphql-markdown.dev
GraphQL-Markdown — GraphQL schema documentation generator
Generate Markdown and MDX documentation from any GraphQL schema. Use the official Docusaurus plugin or formatter presets for Hugo, MkDocs, DocFX, mdBook, and other supported ecosystems.
Starred by 180 users
Forked by 31 users
Languages: TypeScript 90.0% | JavaScript 6.8% | CSS 1.5% | Earthly 0.7% | Shell 0.6% | Dockerfile 0.3% | MDX 0.1%
GraphQL-Markdown
graphql-markdown.dev › getting started
Getting started | GraphQL-Markdown — GraphQL schema documentation generator
Quick start guide for installing and configuring GraphQL-Markdown with Docusaurus, plus the right entry point for formatter-based setups.
Docusaurus
docusaurus.io › introduction
Introduction | Docusaurus
July 10, 2026 - Gatsby does many things well and is suitable for building many types of websites. On the other hand, Docusaurus tries to do one thing super well - be the best tool for writing and publishing content. GraphQL is also pretty core to Gatsby, although you don't necessarily need GraphQL to build a Gatsby site.
CodeSandbox
codesandbox.io › examples › package › @graphql-markdown › docusaurus
@graphql-markdown/docusaurus examples - CodeSandbox
AboutDocusaurus plugin for generating Markdown documentation from a GraphQL schema.6,243Weekly Downloads
Forked by 3 users
Languages: JavaScript 60.7% | CSS 39.3% | JavaScript 60.7% | CSS 39.3%
Vishesh
vishesh.space › generating-graphql-docs
Generating GraphQL Docs
June 14, 2021 - You could use GraphQL Playground to host a live version of your api docs for GraphQL but it helps to have a static version incase you don't want people hitting the api unless they don't really have an account. To generate the docs you would need to feed the schema to (Docusaurus)[https://docusaurus.io/docs].If you are using type-graphql to generate static docs is to first emit the GraphQL schema https://typegraphql.com/docs/emit-schema.html#docsNav.
Hasura
hasura.io › docs › wiki › category › docusaurus-mdx-guide
Docusaurus Markdown Guide Index | Hasura GraphQL Docs
Please refer to the Docusaurus Markdown Frontmatter reference · External Links · Two ways to list table of contents. While adding code blocks, ensure you set the correct language type. Sometimes adding placeholders breaks the language's syntax, in which case you'll have to set the language type to none to avoid warnings during builds.
Top answer 1 of 4
3
I just had exactly the same problem. Basically, Docusaurus with a gQL Playground Integration runs fine in local but won't compile due to errors when running yarn build as above.
In the end I found the answer is in Docusaurus, not in building a custom compiler:
- I switched from using graphql-react-playground to GraphiQL: package: "graphiql": "^1.8.7"
- This moved my error on to a weird one with no references anywhere on the web (rare for me): "no valid fetcher implementation available"
- I fixed the above by importing createGraphiQLFetcher from '@graphiql/create-fetcher' to my component
- Then the error was around not being able to find a window component, this was an easy one, I followed docusaurus docs here: https://docusaurus.io/docs/docusaurus-core#browseronly and wrapped my component on this page in like this:
import BrowserOnly from '@docusaurus/BrowserOnly';
const Explorer = () => {
const { siteConfig } = useDocusaurusContext();
return (
<Layout
title={siteConfig.title}
description="Slerp GraphQL Explorer">
<main>
<BrowserOnly fallback={<div>Loading...</div>}>
{() => {
const GraphEx = GraphExplorer
return <GraphEx />
}}
</BrowserOnly>
</main>
</Layout>
);
}
This now works and builds successfully
2 of 4
0
A few Docusaurus sites have embedded playgrounds:
- Hermes
- Uniforms
In your case you will have to write a plugin to extend the webpack config with file-loader.
CodeSandbox
codesandbox.io › examples › package › @edno › docusaurus2-graphql-doc-generator
@edno/docusaurus2-graphql-doc-generator examples - CodeSandbox
AboutDocusaurus plugin for generating Markdown documentation from a GraphQL schema.290Weekly Downloads
npm
npmjs.com › package › @graphql-markdown › docusaurus
graphql-markdown/docusaurus
February 16, 2025 - Docusaurus docs feature plugin for generating Markdown documentation from a GraphQL schema.
» npm install @graphql-markdown/docusaurus
Published: Feb 25, 2021
Version: 0.4.0
Author: Gabin Aureche