Index

API symbols

`$`:

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

appendChild:

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

apply:

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

AtxHeadingParser:

• markdown: AtxHeadingParser

AutoLink:

• markdown: AutoLink

AutoLinkParser:

• markdown: AutoLinkParser

BlanklineParser:

• markdown: BlanklineParser

Block:

• markdown: Block

BlockChunk:

• ChunkKind.BlockChunk

Blockquote:

• markdown: Blockquote

BlockquoteParser:

• markdown: BlockquoteParser

Chunk:

• markdown: Chunk

ChunkKind:

• markdown: ChunkKind

CodeBlock:

• markdown: CodeBlock

CodeSpan:

• markdown: CodeSpan

CodeSpanParser:

• markdown: CodeSpanParser

Delimiter:

• markdown: Delimiter

DelimiterParser:

• markdown: DelimiterParser

Document:

• markdown: Document

Em:

• markdown: Em

Escape:

• markdown: Escape

escapeAmpersandChar:

• markdown: escapeAmpersandChar(doc: string): string

escapeAmpersandSeq:

• markdown: escapeAmpersandSeq(doc: string): string

escapeBackslash:

• markdown: escapeBackslash(doc: string): string

escapeCode:

• markdown: escapeCode(doc: string): string

escapeHTMLEntity:

• markdown: escapeHTMLEntity(doc: string): string

escapeLinkUrl:

• markdown: escapeLinkUrl(url: string): string

EscapeParser:

• markdown: EscapeParser

escapeQuote:

• markdown: escapeQuote(doc: string): string

escapeTag:

• markdown: escapeTag(doc: string): string

FencedCodeParser:

• markdown: FencedCodeParser

finalizeList:

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

firstLine:

• markdown: firstLine(doc: string): string

getAtxHeading:

• markdown: getAtxHeading(s: string): tuple[level: int, doc: string, size: int]

getDelimiterStack:

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

getFence:

• markdown: getFence(doc: string): tuple[indent: int, fence: string, size: int]

getIndentedCodeFirstLine:

• markdown: getIndentedCodeFirstLine(s: string): tuple[code: string, size: int]

getIndentedCodeRestLines:

• markdown: getIndentedCodeRestLines(s: string): tuple[code: string, size: int]

getLinkDestination:

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

getLinkLabel:

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

getLinkText:

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

getLinkTitle:

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

getSetextHeading:

• markdown: getSetextHeading(s: string): tuple[level: int, doc: string, size: int]

HardBreak:

• markdown: HardBreak

HardBreakParser:

• markdown: HardBreakParser

Heading:

• markdown: Heading

HtmlBlock:

• markdown: HtmlBlock

HtmlBlockParser:

• markdown: HtmlBlockParser

HtmlEntity:

• markdown: HtmlEntity

HtmlEntityParser:

• markdown: HtmlEntityParser

htmlEntityToUtf8:

• entities: htmlEntityToUtf8(s: string): string

HtmlTable:

• markdown: HtmlTable

HtmlTableParser:

• markdown: HtmlTableParser

Image:

• markdown: Image

ImageParser:

• markdown: ImageParser

IndentedCodeParser:

• markdown: IndentedCodeParser

initCommonmarkConfig:

• markdown: 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: 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: Inline

InlineChunk:

• ChunkKind.InlineChunk

InlineHtml:

• markdown: InlineHtml

InlineHtmlParser:

• markdown: InlineHtmlParser

isBlank:

• markdown: isBlank(doc: string): bool

isBlockquote:

• markdown: isBlockquote(s: string): bool

isContinuationText:

• markdown: isContinuationText(doc: string): bool

isOlNo1ListItem:

• markdown: isOlNo1ListItem(doc: string): bool

isUlEmptyListItem:

• markdown: isUlEmptyListItem(doc: string): bool

LazyChunk:

• ChunkKind.LazyChunk

Li:

• markdown: Li

Link:

• markdown: Link

LinkParser:

• markdown: LinkParser

markdown:

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

MarkdownConfig:

• markdown: MarkdownConfig

MarkdownError:

• markdown: MarkdownError

normalizeLabel:

• markdown: normalizeLabel(label: string): string

Ol:

• markdown: Ol

OlParser:

• markdown: OlParser

Paragraph:

• markdown: Paragraph

ParagraphParser:

• markdown: ParagraphParser

parse:

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

parseBlankLine:

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

parseCodeContent:

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

parseCodeInfo:

• markdown: parseCodeInfo(doc: string): tuple[info: string, size: int]

parseHTMLBlockContent:

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

parseHtmlCData:

• markdown: parseHtmlCData(s: string): tuple[html: string, size: int]

parseHtmlComment:

• markdown: parseHtmlComment(s: string): tuple[html: string, size: int]

parseHtmlDeclaration:

• markdown: parseHtmlDeclaration(s: string): tuple[html: string, size: int]

parseHtmlOpenCloseTag:

• markdown: parseHtmlOpenCloseTag(s: string): tuple[html: string, size: int]

parseHtmlTag:

• markdown: parseHtmlTag(s: string): tuple[html: string, size: int]

parseIndentedCode:

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

parseOrderedListItem:

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

parseProcessingInstruction:

• markdown: parseProcessingInstruction(s: string): tuple[html: string, size: int]

Parser:

• markdown: Parser

ParseResult:

• markdown: ParseResult

parseTableAligns:

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

parseTableRow:

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

parseTildeBlockCodeInfo:

• markdown: parseTildeBlockCodeInfo(doc: string): tuple[info: string, size: int]

parseUnorderedListItem:

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

processEmphasis:

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

readCLIOptions:

• markdown: readCLIOptions(): MarkdownConfig

ReferenceParser:

• markdown: ReferenceParser

reFmt:

• markdown: reFmt(patterns: varargs[string]): Regex

removeBlankLines:

• markdown: removeBlankLines(doc: string): string

removeDelimiter:

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

render:

• markdown: render(token: Token): string

replaceInitialTabs:

• markdown: replaceInitialTabs(doc: string): string

restLines:

• markdown: restLines(doc: string): string

scanInlineDelimiters:

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

SetextHeadingParser:

• markdown: SetextHeadingParser

since:

• markdown: since(s: string; i: int; offset: int = -1): string

skipParsing:

• markdown: skipParsing(): ParseResult

SoftBreak:

• markdown: SoftBreak

SoftBreakParser:

• markdown: SoftBreakParser

State:

• markdown: State

Strikethrough:

• markdown: Strikethrough

StrikethroughParser:

• markdown: StrikethroughParser

Strong:

• markdown: Strong

TableRow:

• markdown: TableRow

TBody:

• markdown: TBody

TBodyCell:

• markdown: TBodyCell

Text:

• markdown: Text

TextParser:

• markdown: TextParser

THead:

• markdown: THead

THeadCell:

• markdown: THeadCell

ThematicBreak:

• markdown: ThematicBreak

ThematicBreakParser:

• markdown: ThematicBreakParser

tipToken:

• markdown: tipToken(token: Token): Token

toAlt:

• markdown: toAlt(token: Token): string

Token:

• markdown: Token

toSeq:

• markdown: toSeq(tokens: DoublyLinkedList[Token]): seq[Token]

Ul:

• markdown: Ul

UlParser:

• markdown: UlParser