GraphQL-Markdown + MkDocs demo

This demo generates GraphQL schema documentation into MkDocs using the formatter in @graphql-markdown/formatters/mkdocs with the Read the Docs theme.

Commands

  • npm install installs the local GraphQL-Markdown packages used by the demo.
  • npm run generate regenerates the GraphQL reference into docs/graphql.
  • npm run dev regenerates docs and starts the MkDocs preview server.
  • npm run build regenerates docs and builds the static site.

GraphQL API

Open the generated API reference at GraphQL API.