GraphqlMarkdown.SinglePage (Graphql Markdown v1.1.0)

Copy Markdown View Source

Single page generator from Graphql to Markdown.

Every section is rendered into one document, preceded by a title and an optional table of contents. Links point at anchors inside the page.

Rendering is pure: render_schema/2 returns the page content and never touches the filesystem.

Summary

Functions

Renders the whole schema into a single markdown page.

Functions

render_schema(schema_details, options)

@spec render_schema(GraphqlMarkdown.Schema.t(), keyword()) :: [
  {String.t(), String.t()}
]

Renders the whole schema into a single markdown page.

Returns a one-element list of {filename, content}.