This plugin generates Markdown pages from a GraphQL schema for Docusaurus docs feature.

Installation

graphql package is a peer-dependency, and it should be installed separately.

npm install @graphql-markdown/docusaurus graphql

Add @graphql-markdown/docusaurus to your site's docusaurus.config.js plugins option:

module.exports = {
  // ...
  plugins: ["@graphql-markdown/docusaurus"],
};

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 configuration 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.

Contributions

Contributions, issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!