Index

Modules: marvdown, marvdown/ast, marvdown/components, marvdown/lexer, marvdown/parser.

API symbols

advance:

• parser: proc advance(md: var Markdown; offset = 1)

ComponentScope:

• components: type ComponentScope

debugEcho:

• ast: proc debugEcho(n: MarkdownNode)

decodeHtmlEntities:

• parser: proc decodeHtmlEntities(s: string): string

getAst:

• marvdown: proc getAst(content: sink string): string

getFootnotes:

• parser: proc getFootnotes(md: Markdown): OrderedTableRef[string, MarkdownNode]

getHeader:

• parser: proc getHeader(md: Markdown): YAMLObject

getSelectorItems:

• parser: proc getSelectorItems(md: Markdown): seq[tuple[level: int, anchor, title: string]]

getSelectors:

• parser: proc getSelectors(md: Markdown): OrderedTableRef[string, string]

getSelectorsList:

• parser: proc getSelectorsList(md: Markdown): seq[string]

getTitle:

• parser: proc getTitle(md: Markdown): string

hasFootnotes:

• parser: proc hasFootnotes(md: Markdown): bool

hasSelectors:

• parser: proc hasSelectors(md: Markdown): bool

htmlCommand:

• marvdown: proc htmlCommand(v: Values)

initLexer:

• lexer: proc initLexer(input: sink string; enableEmailAutolinks: bool = false): MarkdownLexer

lazyloadMediaSrc:

• parser: proc lazyloadMediaSrc(html: sink string; tagName: string): string

Markdown:

• parser: type Markdown

MarkdownLexer:

• lexer: object MarkdownLexer

MarkdownNode:

• ast: type MarkdownNode

MarkdownNodeKind:

• ast: enum MarkdownNodeKind

MarkdownNodeList:

• ast: type MarkdownNodeList

MarkdownOptions:

• parser: object MarkdownOptions

MarkdownParser:

• parser: object MarkdownParser

MarkdownTokenKind:

• lexer: enum MarkdownTokenKind

MarkdownTokenTuple:

• lexer: tuple MarkdownTokenTuple

mdkAlert:

• ast: MarkdownNodeKind.mdkAlert

mdkBlockquote:

• ast: MarkdownNodeKind.mdkBlockquote

mdkCodeBlock:

• ast: MarkdownNodeKind.mdkCodeBlock

mdkDocument:

• ast: MarkdownNodeKind.mdkDocument

mdkElement:

• ast: MarkdownNodeKind.mdkElement

mdkEmphasis:

• ast: MarkdownNodeKind.mdkEmphasis

mdkFootnoteDef:

• ast: MarkdownNodeKind.mdkFootnoteDef

mdkFootnoteRef:

• ast: MarkdownNodeKind.mdkFootnoteRef

mdkHeading:

• ast: MarkdownNodeKind.mdkHeading

mdkHorizontalRule:

• ast: MarkdownNodeKind.mdkHorizontalRule

mdkHtml:

• ast: MarkdownNodeKind.mdkHtml

mdkImage:

• ast: MarkdownNodeKind.mdkImage

mdkInlineCode:

• ast: MarkdownNodeKind.mdkInlineCode

mdkLineBreak:

• ast: MarkdownNodeKind.mdkLineBreak

mdkLink:

• ast: MarkdownNodeKind.mdkLink

mdkList:

• ast: MarkdownNodeKind.mdkList

mdkListItem:

• ast: MarkdownNodeKind.mdkListItem

mdkParagraph:

• ast: MarkdownNodeKind.mdkParagraph

mdkStrikethrough:

• ast: MarkdownNodeKind.mdkStrikethrough

mdkStrong:

• ast: MarkdownNodeKind.mdkStrong

mdkTable:

• ast: MarkdownNodeKind.mdkTable

mdkTableCell:

• ast: MarkdownNodeKind.mdkTableCell

mdkTableFooter:

• ast: MarkdownNodeKind.mdkTableFooter

mdkTableHeader:

• ast: MarkdownNodeKind.mdkTableHeader

mdkTableRow:

• ast: MarkdownNodeKind.mdkTableRow

mdkText:

• ast: MarkdownNodeKind.mdkText

mdkUnknown:

• ast: MarkdownNodeKind.mdkUnknown

mtkBlockquote:

• lexer: MarkdownTokenKind.mtkBlockquote

mtkCodeBlock:

• lexer: MarkdownTokenKind.mtkCodeBlock

mtkDocument:

• lexer: MarkdownTokenKind.mtkDocument

mtkElement:

• lexer: MarkdownTokenKind.mtkElement

mtkEmphasis:

• lexer: MarkdownTokenKind.mtkEmphasis

mtkEOF:

• lexer: MarkdownTokenKind.mtkEOF

mtkFootnoteDef:

• lexer: MarkdownTokenKind.mtkFootnoteDef

mtkFootnoteRef:

• lexer: MarkdownTokenKind.mtkFootnoteRef

mtkHeading:

• lexer: MarkdownTokenKind.mtkHeading

mtkHorizontalRule:

• lexer: MarkdownTokenKind.mtkHorizontalRule

mtkHtml:

• lexer: MarkdownTokenKind.mtkHtml

mtkImage:

• lexer: MarkdownTokenKind.mtkImage

mtkInlineCode:

• lexer: MarkdownTokenKind.mtkInlineCode

mtkLineBreak:

• lexer: MarkdownTokenKind.mtkLineBreak

mtkLink:

• lexer: MarkdownTokenKind.mtkLink

mtkLinkDef:

• lexer: MarkdownTokenKind.mtkLinkDef

mtkList:

• lexer: MarkdownTokenKind.mtkList

mtkListItem:

• lexer: MarkdownTokenKind.mtkListItem

mtkListItemCheckbox:

• lexer: MarkdownTokenKind.mtkListItemCheckbox

mtkOListItem:

• lexer: MarkdownTokenKind.mtkOListItem

mtkParagraph:

• lexer: MarkdownTokenKind.mtkParagraph

mtkRefLink:

• lexer: MarkdownTokenKind.mtkRefLink

mtkStrikethrough:

• lexer: MarkdownTokenKind.mtkStrikethrough

mtkStrong:

• lexer: MarkdownTokenKind.mtkStrong

mtkTable:

• lexer: MarkdownTokenKind.mtkTable

mtkText:

• lexer: MarkdownTokenKind.mtkText

mtkUnknown:

• lexer: MarkdownTokenKind.mtkUnknown

newComponentScope:

• components: proc newComponentScope(): ComponentScope

newHeading:

• ast: proc newHeading(level: range[1 .. 6]; ln: int): MarkdownNode

newImage:

• ast: proc newImage(alt, src, title: string; ln: int): MarkdownNode

newLink:

• ast: proc newLink(href, title: string; ln: int): MarkdownNode

newMarkdown:

• parser: proc newMarkdown(content: sink string; opts: MarkdownOptions = defaultOptions): Markdown

newParagraph:

• parser: proc newParagraph(curr: MarkdownTokenTuple): MarkdownNode

newRawHtml:

• ast: proc newRawHtml(html: string; ln: int): MarkdownNode

newText:

• ast: proc newText(text: string; ln: int): MarkdownNode

nextToken:

• lexer: proc nextToken(lex: var MarkdownLexer): MarkdownTokenTuple

preprocess:

• components: proc preprocess(content: string; basePath: string; scope: var ComponentScope; visited: var seq[string]): string

processHtmlContent:

• components: proc processHtmlContent(html: sink string; scope: var ComponentScope): string

resolveVariables:

• components: proc resolveVariables(text: string; scope: ComponentScope): string

tagAll:

• parser: TagType.tagAll

tagBlock:

• parser: TagType.tagBlock

tagInline:

• parser: TagType.tagInline

tagNone:

• parser: TagType.tagNone

TagType:

• parser: enum TagType

toHtml:

• marvdown: proc toHtml(content: sink string): owned string
• parser: proc toHtml(md: var Markdown): string

toJson:

• parser: proc toJson(md: Markdown): string

toXML:

• marvdown: proc toXML(md: var Markdown): XmlNode
• marvdown: proc toXML(content: sink string): XmlNode

transformLines:

• components: proc transformLines(content: string; transform: proc (line: string): string): string