docusaurus-plugin-content-graphql v0.4.0

docusaurus-plugin-content-graphql

Docusaurus plugin generating Markdown documentation from a GraphQL schema.

Usage

1. In an existing Docusaurus project, install the plugin:

yarn add docusaurus-plugin-content-graphql

2. Add the plugin to your docusaurus.config.js file:

module.exports = {
  // preceded by your existing configuration
  // ...
  plugins: [
    [
      "docusaurus-plugin-content-graphql",
      {
        // can be a path, a glob or an URL
        schema: "schema.graphql",
      },
    ],
  ],
};

3. Start the application:

yarn start

4. The plugin will generate Markdown files in the docs/api folder. So you can now add these files to your sidebars.js:

modules.exports = {
  docs: {
    API: [
      "api/queries",
      "api/mutations",
      "api/objects",
      "api/interfaces",
      "api/enums",
      "api/unions",
      "api/inputObjects",
      "api/scalars",
    ],
  },
};

Options

schema

Can be a path, a glob or an URL used to load your GraphQL schema.

routeBasePath

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/",
      },
    ],
  ],
};

With this configuration, the files are still generated in docs/api but the reference links will point to /api/ instead of /docs/api/.