UNPKG

@graphql-markdown/docusaurus

Version:

Docusaurus plugin for generating Markdown documentation from a GraphQL schema.

19 lines 868 B
/** * Docusaurus integration for running GraphQL-Markdown and wiring CLI commands. * * @packageDocumentation */ import type { LoadContext, Plugin, PluginOptions } from "@docusaurus/types"; import type { GraphQLMarkdownCliOptions } from "@graphql-markdown/types"; /** * 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. * * @param _ - Load context (unused). * @param options - GraphQL-Markdown CLI options plus Docusaurus plugin options. * @returns A configured Docusaurus plugin instance. */ export default function pluginGraphQLDocGenerator(_: LoadContext, options: GraphQLMarkdownCliOptions & Partial<PluginOptions>): Promise<Plugin>; export { createMDXFormatter } from "./mdx"; //# sourceMappingURL=index.d.ts.map