gockel

README

Gockel

If you squint really hard, you could call Gockel a GraphQL Schema documentation generator. But it doesn't really do anything. You have to do all the work.

Gockel was purpose-built for docs.sourcehut.org and may or may not generalize well to other use-cases. The templates for that site can be found here, so you can get an idea of how to use Gockel.

In a nutshell, Gockel loads a GraphQL schema from file (no introspection support), parses it into a gqlparser Schema, and - with some minor enhancements - throws that at a standard Go template, which you have to supply yourself.

That's right, there is no default theme. You have to write templates to make Gockel do anything at all.

We are working to supply at least a baseline amount of documentation for Gockel, at which point it might be useful to others.

Documentation

Index

• func AddTemplateHelpers(root *template.Template)
• func Init(filename string, root *template.Template) (*gckl, error)
• func LoadTemplates(path string) (*template.Template, error)
• type EnhancedSchema
  • func (schema *EnhancedSchema) SortedMutations() ast.FieldList
  • func (schema *EnhancedSchema) SortedQueries() ast.FieldList
  • func (schema *EnhancedSchema) SortedSubscriptions() ast.FieldList
  • func (schema *EnhancedSchema) SortedTypeDefinitions() ast.DefinitionList
  • func (schema *EnhancedSchema) TypeDefinition(t *ast.Type) *string

Functions

func AddTemplateHelpers

func AddTemplateHelpers(root *template.Template)

func Init

func Init(filename string, root *template.Template) (*gckl, error)

func LoadTemplates

func LoadTemplates(path string) (*template.Template, error)

Types

type EnhancedSchema

type EnhancedSchema struct {
	*ast.Schema
}

func (*EnhancedSchema) SortedMutations

func (schema *EnhancedSchema) SortedMutations() ast.FieldList

func (*EnhancedSchema) SortedQueries

func (schema *EnhancedSchema) SortedQueries() ast.FieldList

func (*EnhancedSchema) SortedSubscriptions

func (schema *EnhancedSchema) SortedSubscriptions() ast.FieldList

func (*EnhancedSchema) SortedTypeDefinitions

func (schema *EnhancedSchema) SortedTypeDefinitions() ast.DefinitionList

func (*EnhancedSchema) TypeDefinition

func (schema *EnhancedSchema) TypeDefinition(t *ast.Type) *string