Documentation

This generates documentation for your GraphQL service in Commonmark compliant markdown. It also supports rendering the markdown to HTML.

Output

Input:

schema {
	query: Query
}

"Query represents the queries this example provides."
type Query {
	hello: String
}

Output:

# Example Documentation
*This was generated by gqlc.*

## Table of Contents
- [Schema](#Schema)
- [Objects](#Objects)
	* [Query](#Query)

## Schema

*Root Operations*:
- query **([Query](#Query))**

## Objects

### Query
Query represents the queries this example provides.

*Fields*:
- hello **(String)**

Options

html

• Type: Boolean

• Default: false

Render documentation to HTML.

title

• Type: String

• Default: "Documentation"

Set the title for the documentation.