Module

PuduLangDocgen.Markdown

Article text parsed into metadata and a block tree

Types

Name	Description
`Article`	Front matter, blocks, and parse diagnostics of one file

Functions

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.
`fragment`	Documentation text written inside another page, rendered with its headings lowered by `demote` levels so they sit below the page's own sections.
`diagrams`	Sources of the PlantUML diagrams in blocks, in order, each listed once.
`dependencies`	Project-relative paths an article includes or excerpts, in first-mention order. Paths that cannot be located are left for parsing to report.

parse

fn parse(origin: Str, text: Str, files: &Map[Str, Str], alerts: &Array[Str]) -> Article

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.

Parameters

origin: Str
text: Str
files: &Map[Str, Str]
alerts: &Array[Str]

Returns

Article

View source

fragment

fn fragment(text: Str, context: &Phrase.Scope, demote: Int) -> Render.Rendered

Documentation text written inside another page, rendered with its headings lowered by demote levels so they sit below the page's own sections.

Parameters

text: Str
context: &Phrase.Scope
demote: Int

Returns

Render.Rendered

View source

diagrams

fn diagrams(blocks: &Array[Syntax.Block]) -> Array[Str]

Sources of the PlantUML diagrams in blocks, in order, each listed once.

Parameters

blocks: &Array[Syntax.Block]

Returns

Array[Str]

View source

dependencies

fn dependencies(origin: Str, text: Str) -> Array[Str]

Project-relative paths an article includes or excerpts, in first-mention order. Paths that cannot be located are left for parsing to report.

Parameters

origin: Str
text: Str

Returns

Array[Str]

View source

Constants

Name	Description
`ALERTS`	Alert kinds every article may use.

ALERTS

const ALERTS: Array[Str] = ["NOTE", "TIP", "IMPORTANT", "CAUTION", "WARNING"]

Alert kinds every article may use.

Type

Array[Str]

View source