Pudu Docgen
Edit this page

Record

Out

Module PuduLangDocgen.Markdown.Phrase

type Out = {
  pieces: Array[Str],
  headings: Array[Docgen.Heading],
  ids: Array[Str],
  links: Array[Docgen.Link],
  diagnostics: Array[Docgen.Diagnostic],
  features: Array[Str],
  groups: Int,
  notes: Array[Str]
}

View source

Rendered pieces and facts gathered while rendering one page

Fields

Name Type Description
pieces Array[Str]
headings Array[Docgen.Heading]
ids Array[Str]
diagnostics Array[Docgen.Diagnostic]
features Array[Str]
groups Int
notes Array[Str]
Name Description
start An empty accumulator.
emit The accumulator with text appended.
report The accumulator with a diagnostic recorded.
need The accumulator noting that a page needs a client feature such as `math` or `mermaid`.
inlines Inline nodes appended as HTML; `origin` is the file the nodes were written in.
destination The browser destination of a written link, recording local targets for validation. Unsafe and unknown destinations produce diagnostics and answer the empty text.