Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@imtala/gql-docs

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@imtala/gql-docs

A svelte component that creates GraphQL documentation

  • 1.0.7
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

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

Keywords

FAQs

Package last updated on 23 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc