@imtala/gql-docs

Graphql Documentation Creator

Easily create lightweight documentation for your Graphql API.

The resulting website has the following attributes

• Fully static, which means you can host on any file server.
• Each type document has its own rendered HTML document - Snappy and fast UI, good SEO & a low browser footprint.

This tool generates a static website - for every query, mutation or type in you schema a lightweight html page is created. Fast, simple and themeable.

Usage

Use as a svelte component

If you are using svelte and want to integrate gql docs into an existing website you can use the GqlDocumentation component exposed the the npm module: @insola/gql-docs-svelte.

• you will need to install graphql as a dependency, since currently svelte/kit does not include this in the bundle

Use as a cli tool

• Raise an issue if you want to use this tool to create a static site without using svelte. A cli tool will be published on npm shortly.

Examples

• Github's public GraphQL API