GraphqlMarkdown.MultiPage (Graphql Markdown v1.2.0)

Copy Markdown View Source

Multi page generator from Graphql to Markdown.

Every section becomes its own page, so links point at the page holding the referenced type, with the :link_ext extension (ExDoc's .html by default). An index.md with the title and a table of contents linking to every page and entry comes first.

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

Summary

Functions

Renders the schema into one markdown page per section.

Functions

render_schema(schema_details, options)

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

Renders the schema into one markdown page per section.

Returns an ordered list of {filename, content}, starting with index.md.