Skip to content
SPECIFICTION
Get listed

GraphQL Docs

github.com

Web
Visit github.com
Spec score 7.0 #26 of 27 in Developer Documentation Software

Spec sheet

Purpose
GraphQL Docs is a documentation explorer for GraphQL schemas.Read 9 Oct 2026 · github.com
License
The repository identifies its license as MIT.Read 9 Oct 2026 · github.com
Maker
The package metadata names Magnus Hallin as the author.Read 4 Oct 2026 · github.com
Dependencies
The README says the CSS is included in the JavaScript code, so no other dependencies are required for that styling.Read 4 Oct 2026 · github.com
Documentation features
The explorer renders Markdown documentation and recursively searches types and fields reachable from the schema’s root query and mutation objects.Read 4 Oct 2026 · github.com
Field arguments
Field arguments with descriptions are listed in separate tables.Read 9 Oct 2026 · github.com
Installation
The project can be installed from NPM as graphql-docs.Read 9 Oct 2026 · github.com
Limit
The project README says GraphQL Docs does not include querying features.Read 9 Oct 2026 · github.com
Notable limits
Types that cannot be queried are excluded from the explorer.Read 4 Oct 2026 · github.com
Operating modes
It supports dynamic and static documentation modes.Read 4 Oct 2026 · github.com
Package compatibility
The package metadata specifies Node.js version 4.4.0 or higher and React and ReactDOM peer dependencies at version 15.0.1 or higher within the stated range.Read 4 Oct 2026 · github.com
Planned features
Improved navigation and on-page search are listed as planned features.Read 9 Oct 2026 · github.com
React component
In dynamic mode, it exposes a React component that requires a function to run a query against a server and return a Promise.Read 9 Oct 2026 · github.com
Rendered descriptions
Documentation is rendered as Markdown using Marked.Read 9 Oct 2026 · github.com
Schema overview
It aims to provide a better overview of a schema than GraphiQL, without GraphiQL’s querying features.Read 9 Oct 2026 · github.com
Schema traversal
It recursively searches types and fields reachable from the schema’s root query and mutation objects, excluding types that can’t be queried.Read 9 Oct 2026 · github.com
Scope
The project says it aims to give a better schema overview than GraphiQL, without querying features.Read 4 Oct 2026 · github.com
Static generation
The command-line generator can create a static HTML documentation file from a schema file or GraphQL endpoint.Read 4 Oct 2026 · github.com
Static output
The command line generator can create a static HTML documentation file from a schema file or GraphQL endpoint.Read 9 Oct 2026 · github.com
Usage modes
It supports dynamic and static documentation modes.Read 9 Oct 2026 · github.com

Where Specifiction places it

Alternatives to GraphQL DocsAll alternatives →