Index

Modules: markdown, markdownpkg/entities.

API symbols

`$`:

• markdown: proc `$`(chunk: Chunk): string
• markdown: method `$`(token: AutoLink): string
• markdown: method `$`(token: Blockquote): string
• markdown: method `$`(token: CodeBlock): string
• markdown: method `$`(token: CodeSpan): string
• markdown: method `$`(token: Em): string
• markdown: method `$`(token: Escape): string
• markdown: method `$`(token: HardBreak): string
• markdown: method `$`(token: Heading): string
• markdown: method `$`(token: HtmlBlock): string
• markdown: method `$`(token: HtmlEntity): string
• markdown: method `$`(token: HtmlTable): string
• markdown: method `$`(token: Image): string
• markdown: method `$`(token: InlineHtml): string
• markdown: method `$`(token: Li): string
• markdown: method `$`(token: Link): string
• markdown: method `$`(token: Ol): string
• markdown: method `$`(token: Paragraph): string
• markdown: method `$`(token: SoftBreak): string
• markdown: method `$`(token: Strikethrough): string
• markdown: method `$`(token: Strong): string
• markdown: method `$`(token: TableRow): string
• markdown: method `$`(token: TBody): string
• markdown: method `$`(token: TBodyCell): string
• markdown: method `$`(token: Text): string
• markdown: method `$`(token: THead): string
• markdown: method `$`(token: THeadCell): string
• markdown: method `$`(token: ThematicBreak): string
• markdown: method `$`(token: Token): string
• markdown: method `$`(token: Ul): string

appendChild:

• markdown: proc appendChild(token: Token; child: Token)

apply:

• markdown: method apply(this: Blockquote; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Image; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Link; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Ol; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Reference; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Token; state: State; res: ParseResult): ParseResult
• markdown: method apply(this: Ul; state: State; res: ParseResult): ParseResult

AtxHeadingParser:

• markdown: type AtxHeadingParser

AutoLink:

• markdown: type AutoLink

AutoLinkParser:

• markdown: type AutoLinkParser

BlanklineParser:

• markdown: type BlanklineParser

Block:

• markdown: type Block

BlockChunk:

• markdown: ChunkKind.BlockChunk

Blockquote:

• markdown: type Blockquote

BlockquoteParser:

• markdown: type BlockquoteParser

Chunk:

• markdown: type Chunk

ChunkKind:

• markdown: enum ChunkKind

CodeBlock:

• markdown: type CodeBlock

CodeSpan:

• markdown: type CodeSpan

CodeSpanParser:

• markdown: type CodeSpanParser

Delimiter:

• markdown: type Delimiter

DelimiterParser:

• markdown: type DelimiterParser

Document:

• markdown: type Document

Em:

• markdown: type Em

Escape:

• markdown: type Escape

EscapeParser:

• markdown: type EscapeParser

FencedCodeParser:

• markdown: type FencedCodeParser

finalizeList:

• markdown: proc finalizeList(state: State; token: Token)

getAtxHeading:

• markdown: proc getAtxHeading(s: string; start: int = 0): tuple[level: int, doc: string, size: int]

getDelimiterStack:

• markdown: proc getDelimiterStack(token: Token): DoublyLinkedList[Delimiter]

getFence:

• markdown: proc getFence(doc: string; start: int = 0): tuple[indent: int, fence: string, size: int]

getIndentedCodeFirstLine:

• markdown: proc getIndentedCodeFirstLine(doc: string; start: int = 0): tuple[code: string, size: int]

getIndentedCodeRestLines:

• markdown: proc getIndentedCodeRestLines(doc: string; start: int = 0): tuple[code: string, size: int]

getLinkDestination:

• markdown: proc getLinkDestination(doc: string; start: int): tuple[slice: Slice[int], size: int]

getLinkLabel:

• markdown: proc getLinkLabel(doc: string; start: int): tuple[label: string, size: int]

getLinkText:

• markdown: proc getLinkText(doc: string; start: int; allowNested: bool = false): tuple[ slice: Slice[int], size: int]

getLinkTitle:

• markdown: proc getLinkTitle(doc: string; start: int): tuple[slice: Slice[int], size: int]

getSetextHeading:

• markdown: proc getSetextHeading(doc: string; start = 0): tuple[level: int, doc: string, size: int]

HardBreak:

• markdown: type HardBreak

HardBreakParser:

• markdown: type HardBreakParser

Heading:

• markdown: type Heading

HtmlBlock:

• markdown: type HtmlBlock

HtmlBlockParser:

• markdown: type HtmlBlockParser

HtmlEntity:

• markdown: type HtmlEntity

HtmlEntityParser:

• markdown: type HtmlEntityParser

htmlEntityToUtf8:

• entities: proc htmlEntityToUtf8(s: string): string

HtmlTable:

• markdown: type HtmlTable

HtmlTableParser:

• markdown: type HtmlTableParser

Image:

• markdown: type Image

ImageParser:

• markdown: type ImageParser

IndentedCodeParser:

• markdown: type IndentedCodeParser

initCommonmarkConfig:

• markdown: proc initCommonmarkConfig(escape = true; keepHtml = true; blockParsers = @[ ReferenceParser(), ThematicBreakParser(), BlockquoteParser(), UlParser(), OlParser(), IndentedCodeParser(), FencedCodeParser(), HtmlBlockParser(), AtxHeadingParser(), SetextHeadingParser(), BlanklineParser(), ParagraphParser()]; inlineParsers = @[DelimiterParser(), ImageParser(), AutoLinkParser(), LinkParser(), HtmlEntityParser(), InlineHtmlParser(), EscapeParser(), CodeSpanParser(), HardBreakParser(), SoftBreakParser(), TextParser()]): MarkdownConfig

initGfmConfig:

• markdown: proc initGfmConfig(escape = true; keepHtml = true; blockParsers = @[ ReferenceParser(), ThematicBreakParser(), BlockquoteParser(), UlParser(), OlParser(), IndentedCodeParser(), FencedCodeParser(), HtmlBlockParser(), HtmlTableParser(), AtxHeadingParser(), SetextHeadingParser(), BlanklineParser(), ParagraphParser()]; inlineParsers = @[DelimiterParser(), ImageParser(), AutoLinkParser(), LinkParser(), HtmlEntityParser(), InlineHtmlParser(), EscapeParser(), StrikethroughParser(), CodeSpanParser(), HardBreakParser(), SoftBreakParser(), TextParser()]): MarkdownConfig

Inline:

• markdown: type Inline

InlineChunk:

• markdown: ChunkKind.InlineChunk

InlineHtml:

• markdown: type InlineHtml

InlineHtmlParser:

• markdown: type InlineHtmlParser

isBlockquote:

• markdown: proc isBlockquote(s: string; start: int = 0): bool

isContinuationText:

• markdown: proc isContinuationText(doc: string; start: int = 0; stop: int = 0): bool

isOlNo1ListItem:

• markdown: proc isOlNo1ListItem(doc: string; start: int = 0; stop: int = 0): bool

isUlEmptyListItem:

• markdown: proc isUlEmptyListItem(doc: string; start: int = 0; stop: int = 0): bool

LazyChunk:

• markdown: ChunkKind.LazyChunk

Li:

• markdown: type Li

Link:

• markdown: type Link

LinkParser:

• markdown: type LinkParser

markdown:

• markdown: proc markdown(doc: string; config: MarkdownConfig = nil; root: Token = Document()): string

MarkdownConfig:

• markdown: type MarkdownConfig

MarkdownError:

• markdown: object MarkdownError

matchHtmlStart:

• markdown: proc matchHtmlStart(doc: string; start: int = 0; bufsize: int = 0): tuple[ startRe: Regex, endRe: Regex, endMatch: bool, continuation: bool]

normalizeLabel:

• markdown: proc normalizeLabel(label: string): string

Ol:

• markdown: type Ol

OlParser:

• markdown: type OlParser

Paragraph:

• markdown: type Paragraph

ParagraphParser:

• markdown: type ParagraphParser

parse:

• markdown: proc parse(state: State; token: Token)
• markdown: method parse(this: AutoLinkParser; doc: string; start: int): ParseResult
• markdown: method parse(this: BlanklineParser; doc: string; start: int): ParseResult
• markdown: method parse(this: BlockquoteParser; doc: string; start: int): ParseResult
• markdown: method parse(this: CodeSpanParser; doc: string; start: int): ParseResult
• markdown: method parse(this: DelimiterParser; doc: string; start: int): ParseResult
• markdown: method parse(this: EscapeParser; doc: string; start: int): ParseResult
• markdown: method parse(this: FencedCodeParser; doc: string; start: int): ParseResult
• markdown: method parse(this: HardBreakParser; doc: string; start: int): ParseResult
• markdown: method parse(this: HtmlBlockParser; doc: string; start: int): ParseResult
• markdown: method parse(this: HtmlEntityParser; doc: string; start: int): ParseResult
• markdown: method parse(this: HtmlTableParser; doc: string; start: int): ParseResult
• markdown: method parse(this: ImageParser; doc: string; start: int): ParseResult
• markdown: method parse(this: IndentedCodeParser; doc: string; start: int): ParseResult
• markdown: method parse(this: InlineHtmlParser; doc: string; start: int): ParseResult
• markdown: method parse(this: LinkParser; doc: string; start: int): ParseResult
• markdown: method parse(this: OlParser; doc: string; start: int): ParseResult
• markdown: method parse(this: ParagraphParser; doc: string; start: int): ParseResult
• markdown: method parse(this: Parser; doc: string; start: int): ParseResult
• markdown: method parse(this: ReferenceParser; doc: string; start: int): ParseResult
• markdown: method parse(this: SoftBreakParser; doc: string; start: int): ParseResult
• markdown: method parse(this: StrikethroughParser; doc: string; start: int): ParseResult
• markdown: method parse(this: TextParser; doc: string; start: int): ParseResult
• markdown: method parse(this: ThematicBreakParser; doc: string; start: int): ParseResult
• markdown: method parse(this: UlParser; doc: string; start: int): ParseResult

parseBlankLine:

• markdown: proc parseBlankLine(doc: string; start: int): ParseResult

parseCodeContent:

• markdown: proc parseCodeContent(doc: string; indent: int; fence: string): tuple[code: string, size: int]

parseCodeInfo:

• markdown: proc parseCodeInfo(doc: string; start: int = 0): tuple[info: string, size: int]

parseHTMLBlockContent:

• markdown: proc parseHTMLBlockContent(doc: string; startPattern: string; endPattern: string; ignoreCase = false): tuple[html: string, size: int]

parseIndentedCode:

• markdown: proc parseIndentedCode(doc: string; start: int): ParseResult

parseOrderedListItem:

• markdown: proc parseOrderedListItem(doc: string; start = 0; marker: var string; listItemDoc: var string; index: var int = 1): int

Parser:

• markdown: type Parser

ParseResult:

• markdown: type ParseResult

parseTableAligns:

• markdown: proc parseTableAligns(doc: string): tuple[aligns: seq[string], matched: bool]

parseTableRow:

• markdown: proc parseTableRow(doc: string): seq[string]

parseTildeBlockCodeInfo:

• markdown: proc parseTildeBlockCodeInfo(doc: string; start: int = 0): tuple[info: string, size: int]

parseUnorderedListItem:

• markdown: proc parseUnorderedListItem(doc: string; start = 0; marker: var string; listItemDoc: var string): int

processEmphasis:

• markdown: proc processEmphasis(state: State; token: Token)

readCLIOptions:

• markdown: proc readCLIOptions(): MarkdownConfig

ReferenceParser:

• markdown: type ReferenceParser

removeDelimiter:

• markdown: proc removeDelimiter(delimiter: var DoublyLinkedNode[Delimiter])

render:

• markdown: proc render(token: Token; sep = " "): string

replaceInitialTabs:

• markdown: proc replaceInitialTabs(doc: string): string

scanInlineDelimiters:

• markdown: proc scanInlineDelimiters(doc: string; start: int; delimiter: var Delimiter)

SetextHeadingParser:

• markdown: type SetextHeadingParser

SoftBreak:

• markdown: type SoftBreak

SoftBreakParser:

• markdown: type SoftBreakParser

State:

• markdown: type State

Strikethrough:

• markdown: type Strikethrough

StrikethroughParser:

• markdown: type StrikethroughParser

Strong:

• markdown: type Strong

TableRow:

• markdown: type TableRow

TBody:

• markdown: type TBody

TBodyCell:

• markdown: type TBodyCell

Text:

• markdown: type Text

TextParser:

• markdown: type TextParser

THead:

• markdown: type THead

THeadCell:

• markdown: type THeadCell

ThematicBreak:

• markdown: type ThematicBreak

ThematicBreakParser:

• markdown: type ThematicBreakParser

tipToken:

• markdown: proc tipToken(token: Token): Token

toAlt:

• markdown: proc toAlt(token: Token): string

Token:

• markdown: type Token

Ul:

• markdown: type Ul

UlParser:

• markdown: type UlParser