package
1.7.8
Repository: https://github.com/yuin/goldmark.git
Documentation: pkg.go.dev

# Functions

DumpHelper is a helper function to implement Node.Dump.
IsParagraph returns true if the given node implements the Paragraph interface, otherwise false.
MergeOrAppendTextSegment merges a given s into the last child of the parent if it can be merged, otherwise creates a new Text node and appends it to after current last child.
MergeOrReplaceTextSegment merges a given s into a previous sibling of the node n if a previous sibling of the node n is *Text, otherwise replaces Node n with s.
NewAutoLink returns a new AutoLink node.
NewBlockquote returns a new Blockquote node.
NewCodeBlock returns a new CodeBlock node.
NewCodeSpan returns a new CodeSpan node.
NewDocument returns a new Document node.
NewEmphasis returns a new Emphasis node with the given level.
NewFencedCodeBlock return a new FencedCodeBlock node.
NewHeading returns a new Heading node.
NewHTMLBlock returns a new HTMLBlock node.
NewImage returns a new Image node.
NewLink returns a new Link node.
NewList returns a new List node.
NewListItem returns a new ListItem node.
NewNodeKind returns a new Kind value.
NewParagraph returns a new Paragraph node.
NewRawHTML returns a new RawHTML node.
NewRawTextSegment returns a new Text node with the given source position.
NewString returns a new String node.
NewText returns a new Text node.
NewTextBlock returns a new TextBlock node.
NewTextSegment returns a new Text node with the given source position.
NewThematicBreak returns a new ThematicBreak node.
Walk walks a AST tree by the depth first search algorithm.

# Constants

AutoLinkEmail indicates that an autolink is an email address.
AutoLinkURL indicates that an autolink is a generic URL.
HTMLBlockType1 represents type 1 html blocks.
HTMLBlockType2 represents type 2 html blocks.
HTMLBlockType3 represents type 3 html blocks.
HTMLBlockType4 represents type 4 html blocks.
HTMLBlockType5 represents type 5 html blocks.
HTMLBlockType6 represents type 6 html blocks.
HTMLBlockType7 represents type 7 html blocks.
TypeBlock indicates that a node is kind of block nodes.
TypeDocument indicates that a node is kind of document nodes.
TypeInline indicates that a node is kind of inline nodes.
WalkContinue indicates that Walk can continue to walk.
WalkSkipChildren indicates that Walk wont walk on children of current node.
WalkStop indicates no more walking needed.

# Variables

KindAutoLink is a NodeKind of the AutoLink node.
KindBlockquote is a NodeKind of the Blockquote node.
KindCodeBlock is a NodeKind of the CodeBlock node.
KindCodeSpan is a NodeKind of the CodeSpan node.
KindDocument is a NodeKind of the Document node.
KindEmphasis is a NodeKind of the Emphasis node.
KindFencedCodeBlock is a NodeKind of the FencedCodeBlock node.
KindHeading is a NodeKind of the Heading node.
KindHTMLBlock is a NodeKind of the HTMLBlock node.
KindImage is a NodeKind of the Image node.
KindLink is a NodeKind of the Link node.
KindList is a NodeKind of the List node.
KindListItem is a NodeKind of the ListItem node.
KindParagraph is a NodeKind of the Paragraph node.
KindRawHTML is a NodeKind of the RawHTML node.
KindString is a NodeKind of the String node.
KindText is a NodeKind of the Text node.
KindTextBlock is a NodeKind of the TextBlock node.
KindThematicBreak is a NodeKind of the ThematicBreak node.

# Structs

An Attribute is an attribute of the Node.
An AutoLink struct represents an autolink of the Markdown text.
A BaseBlock struct implements the Node interface partialliy.
A BaseInline struct implements the Node interface partialliy.
A BaseNode struct implements the Node interface partialliy.
A Blockquote struct represents an blockquote block of Markdown text.
A CodeBlock interface represents an indented code block of Markdown text.
A CodeSpan struct represents a code span of Markdown text.
A Document struct is a root node of Markdown text.
An Emphasis struct represents an emphasis of Markdown text.
A FencedCodeBlock struct represents a fenced code block of Markdown text.
A Heading struct represents headings like SetextHeading and ATXHeading.
An HTMLBlock struct represents an html block of Markdown text.
An Image struct represents an image of the Markdown text.
A Link struct represents a link of the Markdown text.
A List struct represents a list of Markdown text.
A ListItem struct represents a list item of Markdown text.
A Paragraph struct represents a paragraph of Markdown text.
A RawHTML struct represents an inline raw HTML of the Markdown text.
A String struct is a textual content that has a concrete value.
A Text struct represents a textual content of the Markdown text.
A TextBlock struct is a node whose lines should be rendered without any containers.
A ThematicBreak struct represents a thematic break of Markdown text.

# Interfaces

A Node interface defines basic AST node functionalities.

# Type aliases

AutoLinkType defines kind of auto links.
HTMLBlockType represents kinds of an html blocks.
NodeKind indicates more specific type than NodeType.
A NodeType indicates what type a node belongs to.
Walker is a function that will be called when Walk find a new node.
WalkStatus represents a current status of the Walk function.