Registry / devops / docusaurus-graphql-plugin

docusaurus-graphql-plugin

library0.9.0jsnpmunverified

Docusaurus plugin that generates Markdown documentation from a GraphQL schema. Current version 0.9.0, release cadence is irregular with occasional updates. Key differentiators: parses GraphQL schemas to produce markdown files for Docusaurus sites without manual documentation, handles types, fields, arguments, and directives. Alternative to graphql-docs or graphql-markdown, integrated as a Docusaurus plugin.

devops testing

npm install docusaurus-graphql-plugin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DOCUSAURUS-GRAPHQL

docusaurus-graphql-plugin

devopsjavascriptv0.9.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

graphql-plugin

✓ module.exports = { plugins: ['docusaurus-graphql-plugin'] }

✗ import { graphqlPlugin } from 'docusaurus-graphql-plugin'

Plugin is used in Docusaurus config as a string; no ES import.

default

✓ import plugin from 'docusaurus-graphql-plugin'; module.exports = { plugins: [plugin] }

✗ const plugin = require('docusaurus-graphql-plugin')

The package exports a function (the plugin factory) as default export. CJS require may not work in ESM context.

PluginOptions

✓ import type { PluginOptions } from 'docusaurus-graphql-plugin'

✗ import { PluginOptions } from 'docusaurus-graphql-plugin'

Type import only; runtime usage not valid.

Configure the plugin in docusaurus.config.js to generate docs from a schema file.

// docusaurus.config.js const schema = './schema.graphql'; module.exports = { title: 'My Site', plugins: [ ['docusaurus-graphql-plugin', { schema: schema, rootPath: './docs/graphql', // where to output markdown linkRoot: '../', // relative links to other docs }], ], };

Debug

Known issues

breakingVersion 0.9.0 changed the plugin options structure; 'schema' now expects a string path instead of a DocumentNode.

fix

Update config to pass schema as a file path string.

affects: >=0.9.0

deprecated'rootPath' option is deprecated in favor of 'outputDir' as of 0.9.0.

fix

Use 'outputDir' instead of 'rootPath'.

affects: >=0.9.0

gotchaPlugin may not generate docs for all schema types if 'linkRoot' is not correctly set; links to other docs break.

fix

Ensure 'linkRoot' matches your Docusaurus site structure.

affects: >=0.0.0

gotchaPlugin requires GraphQL peer dependency version ^16.0.0; using older GraphQL may cause parsing errors.

fix

Install graphql@^16.0.0.

affects: >=0.9.0

Errors

Common errors & fixes

Error: Cannot find module 'graphql'

Missing peer dependency GraphQL.

fix

npm install graphql

TypeError: schema is not a string

Passed a GraphQL DocumentNode or object instead of a file path string.

fix

Provide schema as a file path string (e.g., './schema.graphql').

Error: 'outputDir' is required

Missing required option 'outputDir' in version 0.9.0.

fix

Add outputDir to plugin options.

Upgrade

Version history

0.9.0latest on npm

Audit

Dependencies

graphqlrequiredPeer dependency for parsing GraphQL schemas

Agent activity

11 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/Zhouzi/docusaurus-graphql-plugin ↗

packagedocusaurus-graphql-plugin ↗

homepagehttps://github.com/zhouzi/docusaurus-graphql-plugin/ ↗