index

Docusaurus integration for running GraphQL-Markdown and wiring CLI commands.

default()

function default(_, options): Promise<Plugin>;

Defined in: index.ts:31

Docusaurus plugin wrapper that wires GraphQL-Markdown into the build, optionally running the CLI during docusaurus build and registering the graphql-to-doc command on the local CLI.

Parameters

_

LoadContext

Load context (unused).

options

ConfigOptions & Partial<ExperimentalConfigOptions> & Partial<PluginOptions>

GraphQL-Markdown CLI options plus Docusaurus plugin options.

Returns

Promise<Plugin>

A configured Docusaurus plugin instance.