GitHub
github.com › zhouzi › docusaurus-graphql-plugin
GitHub - zhouzi/docusaurus-graphql-plugin: Docusaurus plugin generating Markdown documentation from a GraphQL schema. · GitHub
This is the gap that this plugin tries to fill. Its goal is to generate documentation that is easy to browse and share with minimum prior experience. To reach this goal, it takes most of its ideas from GitHub's GraphQL API documentation. In an existing Docusaurus project, install the 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
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%
npm
npmjs.com › package › docusaurus-graphql-plugin
docusaurus-graphql-plugin - npm
November 8, 2022 - This is the gap that this plugin tries to fill. Its goal is to generate documentation that is easy to browse and share with minimum prior experience. To reach this goal, it takes most of its ideas from GitHub's GraphQL API documentation. In an existing Docusaurus project, install the plugin:
» 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
Latest version: 1.13.1, last published: 4 years ago. Start using @edno/docusaurus2-graphql-doc-generator in your project by running `npm i @edno/docusaurus2-graphql-doc-generator`. There are no other projects in ...
» npm install @edno/docusaurus2-graphql-doc-generator
Published: Sep 04, 2022
Version: 1.13.1
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 · Latest version1.30.3 · LicenseMIT · External Links · graphql-markdown.dev · github.com/graphql-markdown/graphql-markdown · github.com/graphql-markdown/graphql-markdown/issues · ...
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 · Latest version1.13.1 · LicenseMIT · External Links · graphql-markdown.github.io · github.com/graphql-markdown/graphql-markdown · github.com/graphql-markdown/graphql-markdown/issues · @@edno/docusaurus2-graphql-doc-generatorCollaborators
GraphQL-Markdown
graphql-markdown.dev
GraphQL-Markdown — GraphQL schema documentation generator
Start with the CLI, then choose the Docusaurus plugin or a formatter preset for Hugo, MkDocs, DocFX, mdBook, and other supported ecosystems. ... MozillaIOTABitqueryBrowserless.ioAragonSablierMONEICivicEngineepilotCoral+20 more·12k+ weekly downloads
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.
Yarn
classic.yarnpkg.com › en › package › docusaurus-graphql-plugin
docusaurus-graphql-plugin
Fast, reliable, and secure dependency management.
Forked by 3 users
Languages: JavaScript 60.7% | CSS 39.3% | JavaScript 60.7% | CSS 39.3%
Starred by 6 users
Forked by 2 users
Languages: JavaScript 60.0% | CSS 39.3% | Dockerfile 0.7% | JavaScript 60.0% | CSS 39.3% | Dockerfile 0.7%
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.
npm
npm.io › home › docusaurus-plugin-content-graphql
docusaurus-plugin-content-graphql | npm.io
February 25, 2021 - Can be a path, a glob or an URL used to load your GraphQL schema. By default this is set to /docs/api/ which means that the Markdown files will be generated in docs/api. You can change the name of the generated folder and path to api-reference by setting this to: /docs/api-reference/. This option is also useful if you used the docs plugin's routeBasePath. For example, if you opted for docs only: module.exports = { // preceded by your existing configuration // ... presets: [ [ "@docusaurus/preset-classic", { docs: { sidebarPath: require.resolve("./sidebars.js"), editUrl: "https://github.com/facebook/docusaurus/edit/master/website/", routeBasePath: "/", }, }, ], ], plugins: [ [ "docusaurus-plugin-content-graphql", { schema: "schema.graphql", routeBasePath: "/api/", }, ], ], };
Published: Feb 25, 2021
Version: 0.4.0
Author: Gabin Aureche