- Home
- Developer Documentation Software
- GraphQL Docs
On the recordRead 9 Oct 202620 facts
GraphQL Docs
On the record
- Dependencies
- The README says the CSS is included in the JavaScript code, so no other dependencies are required for that styling.github.com · read 4 Oct 2026
- Documentation features
- The explorer renders Markdown documentation and recursively searches types and fields reachable from the schema’s root query and mutation objects.github.com · read 4 Oct 2026
- Field arguments
- Field arguments with descriptions are listed in separate tables.github.com · read 9 Oct 2026
- Installation
- The project can be installed from NPM as graphql-docs.github.com · read 9 Oct 2026
- License
- The repository identifies its license as MIT.github.com · read 9 Oct 2026
- Limit
- The project README says GraphQL Docs does not include querying features.github.com · read 9 Oct 2026
- Maker
- The package metadata names Magnus Hallin as the author.github.com · read 4 Oct 2026
- Notable limits
- Types that cannot be queried are excluded from the explorer.github.com · read 4 Oct 2026
- Operating modes
- It supports dynamic and static documentation modes.github.com · read 4 Oct 2026
- 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.github.com · read 4 Oct 2026
- Planned features
- Improved navigation and on-page search are listed as planned features.github.com · read 9 Oct 2026
- Purpose
- GraphQL Docs is a documentation explorer for GraphQL schemas.github.com · read 9 Oct 2026
- 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.github.com · read 9 Oct 2026
- Rendered descriptions
- Documentation is rendered as Markdown using Marked.github.com · read 9 Oct 2026
- Schema overview
- It aims to provide a better overview of a schema than GraphiQL, without GraphiQL’s querying features.github.com · read 9 Oct 2026
- 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.github.com · read 9 Oct 2026
- Scope
- The project says it aims to give a better schema overview than GraphiQL, without querying features.github.com · read 4 Oct 2026
- Static generation
- The command-line generator can create a static HTML documentation file from a schema file or GraphQL endpoint.github.com · read 4 Oct 2026
