GraphqlMarkdown.Page.Layout (Graphql Markdown v1.2.0)

Copy Markdown View Source

What differs between page layouts.

  • section_level - heading level of a section title; entries use the next level down.
  • link - turns an introspection type reference into the URL a link to that type should point at.
  • page_link - the URL of a section (given its name and nil) or of an entry in it (given the section and the entry's name).
  • depth - how many nested levels the example operations select.
  • backlinks - the GraphqlMarkdown.Backlinks index, or nil when backlinks are not rendered.

Summary

Types

t()

@type t() :: %GraphqlMarkdown.Page.Layout{
  backlinks: GraphqlMarkdown.Backlinks.t() | nil,
  depth: pos_integer(),
  link: (map() -> String.t()),
  page_link: (String.t(), String.t() | nil -> String.t()),
  section_level: pos_integer()
}