Record

Article

Module PuduLangDocgen.Markdown

type Article = {
  meta: Array[(Str, Docgen.Meta)],
  blocks: Array[Syntax.Block],
  diagnostics: Array[Docgen.Diagnostic]
}

View source

Front matter, blocks, and parse diagnostics of one file

Fields

Name Type Description
meta Array[(Str, Docgen.Meta)]
blocks Array[Syntax.Block]
diagnostics Array[Docgen.Diagnostic]
Name Description
parse An article written at a project-relative path. `files` holds the text of every file it may include or excerpt; `alerts` adds alert kinds to the built-in ones.