Module
marksy/ast
src/marksy/ast.pookaMarkdown gets a shape before it gets a costume. Blocks retain addresses in the original UTF-8 source; inline nodes retain the distinctions a renderer needs without keeping the spelling of every delimiter.
let text = ast.Text("owl")
let emphasis = ast.Emphasis([text])
API reference
- classPosition
- classSpan
- classDocument
- classBlock
- classParagraph
- classHeading
- classThematicBreak
- classCodeBlock
- classBlockQuote
- classListBlock
- classListItem
- classReferenceDefinition
- classSourceInline
- classRawBlock
- classInline
- classText
- classCode
- classSoftBreak
- classHardBreak
- classEmphasis
- classStrong
- classLink
- classImage
- classRawInline
- enumAlignment
- classTable
- classStrikethrough
class Position(line: Int, column: Int, byte_offset: Int)
Lines and columns count from one; byte offsets count from zero.
line: Int
Intcolumn: Int
Intbyte_offset: Int
Int
fn(Int, Int, Int) -> marksy/ast.Positionclass Span(start: Position, end: Position)
A half-open interval: the end is just past the last source character.
start: Position
marksy/ast.Positionend: Position
marksy/ast.Position
fn(marksy/ast.Position, marksy/ast.Position) -> marksy/ast.Spanclass Document(blocks: List(Block))
Block children are ordered exactly as they appeared in the source.
blocks: List(Block)
List(marksy/ast.Block)
fn(List(marksy/ast.Block)) -> marksy/ast.Documentclass Block
class Paragraph(content: List(Inline), span: Span) is Block
content: List(Inline)
List(marksy/ast.Inline)span: Span
marksy/ast.Span
fn(List(marksy/ast.Inline), marksy/ast.Span) -> marksy/ast.Paragraphclass Heading(level: Int, content: List(Inline), span: Span) is Block
level: Int
Intcontent: List(Inline)
List(marksy/ast.Inline)span: Span
marksy/ast.Span
fn(Int, List(marksy/ast.Inline), marksy/ast.Span) -> marksy/ast.Headingclass ThematicBreak(span: Span) is Block
span: Span
marksy/ast.Span
fn(marksy/ast.Span) -> marksy/ast.ThematicBreakclass CodeBlock(code: String, info: String, span: Span) is Block
code: String
Stringinfo: String
Stringspan: Span
marksy/ast.Span
fn(String, String, marksy/ast.Span) -> marksy/ast.CodeBlockclass BlockQuote(blocks: List(Block), span: Span) is Block
blocks: List(Block)
List(marksy/ast.Block)span: Span
marksy/ast.Span
fn(List(marksy/ast.Block), marksy/ast.Span) -> marksy/ast.BlockQuoteclass ListBlock(
ordered: Bool,
start: Int,
tight: Bool,
items: List(ListItem),
span: Span
) is Block
A list owns its marker family and tightness; nested lists decide their own.
ordered: Bool
Boolstart: Int
Inttight: Bool
Boolitems: List(ListItem)
List(marksy/ast.ListItem)span: Span
marksy/ast.Span
fn(Bool, Int, Bool, List(marksy/ast.ListItem), marksy/ast.Span) -> marksy/ast.ListBlockclass ListItem(blocks: List(Block), span: Span, checked: Option(Bool))
Item children remain ordinary blocks, including nested lists and code.
blocks: List(Block)
List(marksy/ast.Block)span: Span
marksy/ast.Spanchecked: Option(Bool)
Option(Bool)
fn(List(marksy/ast.Block), marksy/ast.Span, Option(Bool)) -> marksy/ast.ListItemclass ReferenceDefinition(
label: String,
destination: String,
title: String,
span: Span
) is Block
Reference definitions disappear after the document-wide resolution pass.
label: String
Stringdestination: String
Stringtitle: String
Stringspan: Span
marksy/ast.Span
fn(String, String, String, marksy/ast.Span) -> marksy/ast.ReferenceDefinitionclass SourceInline(source: String) is Inline
The block pass defers inline parsing until every definition is known.
source: String
String
fn(String) -> marksy/ast.SourceInlineclass RawBlock(html: String, span: Span) is Block
html: String
Stringspan: Span
marksy/ast.Span
fn(String, marksy/ast.Span) -> marksy/ast.RawBlockclass Inline
class Text(value: String) is Inline
value: String
String
fn(String) -> marksy/ast.Textclass Code(value: String) is Inline
value: String
String
fn(String) -> marksy/ast.Codeclass SoftBreak is Inline
class HardBreak is Inline
class Emphasis(content: List(Inline)) is Inline
content: List(Inline)
List(marksy/ast.Inline)
fn(List(marksy/ast.Inline)) -> marksy/ast.Emphasisclass Strong(content: List(Inline)) is Inline
content: List(Inline)
List(marksy/ast.Inline)
fn(List(marksy/ast.Inline)) -> marksy/ast.Strongclass Link(content: List(Inline), destination: String, title: String) is Inline
content: List(Inline)
List(marksy/ast.Inline)destination: String
Stringtitle: String
String
fn(List(marksy/ast.Inline), String, String) -> marksy/ast.Linkclass Image(description: List(Inline), destination: String, title: String) is Inline
description: List(Inline)
List(marksy/ast.Inline)destination: String
Stringtitle: String
String
fn(List(marksy/ast.Inline), String, String) -> marksy/ast.Imageclass RawInline(html: String) is Inline
html: String
String
fn(String) -> marksy/ast.RawInlineenum Alignment
Column alignment is semantic, not CSS supplied by the source document.
Alignment.Default
Alignment.Left
Alignment.Center
Alignment.Right
class Table(
alignments: List(Alignment),
header: List(List(Inline)),
rows: List(List(List(Inline))),
span: Span
) is Block
alignments: List(Alignment)
List(marksy/ast.Alignment)header: List(List(Inline))
List(List(marksy/ast.Inline))rows: List(List(List(Inline)))
List(List(List(marksy/ast.Inline)))span: Span
marksy/ast.Span
fn(List(marksy/ast.Alignment), List(List(marksy/ast.Inline)), List(List(List(marksy/ast.Inline))), marksy/ast.Span) -> marksy/ast.Tableclass Strikethrough(content: List(Inline)) is Inline
content: List(Inline)
List(marksy/ast.Inline)
fn(List(marksy/ast.Inline)) -> marksy/ast.Strikethrough