Module

PuduLangDocgen.Markdown.Blocks

View source

Recursive block structure with includes and excerpts

Types

Name Description
Env The file being parsed, loaded files, and include trail
Parsed Blocks with the diagnostics found while reading them

Functions

Name Description
environment A parsing environment for a project-relative file with extra alert kinds.
parse Blocks of numbered lines.
inlines Inline content of text starting at a line, with inline includes resolved.

environment

fn environment(origin: Str, files: &Map[Str, Str], alerts: &Set[Str]) -> Env

A parsing environment for a project-relative file with extra alert kinds.

Parameters

origin
Str
files
&Map[Str, Str]
alerts
&Set[Str]

Returns

Env

View source

parse

fn parse(lines: &Array[FrontMatter.Line], env: &Env, depth: Int) -> Parsed

Blocks of numbered lines.

Parameters

lines
&Array[FrontMatter.Line]
env
&Env
depth
Int

Returns

Parsed

View source

inlines

fn inlines(text: Str, line: Int, env: &Env, depth: Int) -> (Array[Syntax.Inline], Array[Docgen.Diagnostic])

Inline content of text starting at a line, with inline includes resolved.

Parameters

text
Str
line
Int
env
&Env
depth
Int

Returns

(Array[Syntax.Inline], Array[Docgen.Diagnostic])

View source