# Functions
DefaultBlockParsers returns a new list of default BlockParsers.
DefaultInlineParsers returns a new list of default InlineParsers.
DefaultParagraphTransformers returns a new list of default ParagraphTransformers.
NewATXHeadingParser return a new BlockParser that can parse ATX headings.
NewAutoLinkParser returns a new InlineParser that parses autolinks surrounded by '<' and '>' .
NewBlockquoteParser returns a new BlockParser that parses blockquotes.
NewCodeBlockParser returns a new BlockParser that parses code blocks.
NewCodeSpanParser return a new InlineParser that parses inline codes surrounded by '`' .
NewConfig returns a new Config.
NewContext returns a new Context.
NewContextKey return a new ContextKey value.
NewDelimiter returns a new Delimiter node.
NewEmphasisParser return a new InlineParser that parses emphasises.
NewFencedCodeBlockParser returns a new BlockParser that parses fenced code blocks.
NewHTMLBlockParser return a new BlockParser that can parse html blocks.
NewLinkParser return a new InlineParser that parses links.
NewListItemParser returns a new BlockParser that parses list items.
NewListParser returns a new BlockParser that parses lists.
NewParagraphParser returns a new BlockParser that parses paragraphs.
NewParser returns a new Parser with given options.
NewRawHTMLParser return a new InlineParser that can parse inline htmls.
NewReference returns a new Reference.
NewSetextHeadingParser return a new BlockParser that can parse Setext headings.
NewThematicBreakParser returns a new BlockParser that parses thematic breaks.
ParseAttributes parses attributes into a map.
ProcessDelimiters processes the delimiter list in the context.
ScanDelimiter scans a delimiter by given DelimiterProcessor.
WithASTTransformers is a functional option that allow you to add ASTTransformers to the parser.
WithAttribute is a functional option that enables custom attributes.
WithAutoHeadingID is a functional option that enables custom heading ids and auto generated heading ids.
WithBlockParsers is a functional option that allow you to add BlockParsers to the parser.
WithContext is a functional option that allow you to override a default context.
WithEscapedSpace is a functional option indicates that a '\' escaped half-space(0x20) should not trigger parsers.
WithHeadingAttribute is a functional option that enables custom heading attributes.
WithIDs is a functional option for the Context.
WithInlineParsers is a functional option that allow you to add InlineParsers to the parser.
WithOption is a functional option that allow you to set an arbitrary option to the parser.
WithParagraphTransformers is a functional option that allow you to add ParagraphTransformers to the parser.
# Constants
Close indicates parser cannot parse anymore.
Continue indicates parser can continue parsing.
HasChildren indicates parser may have child blocks.
NoChildren indicates parser does not have child blocks.
None is a default value of the [State].
RequireParagraph indicates parser requires that the last node must be a paragraph and is not converted to other nodes by ParagraphTransformers.
# Variables
ContextKeyMax is a maximum value of the ContextKey.
LinkReferenceParagraphTransformer is a ParagraphTransformer implementation that parses and extracts link reference from paragraphs.
# Structs
An Attribute is an attribute of the markdown elements.
A Block struct holds a node and correspond parser pair.
A Config struct is a data structure that holds configuration of the Parser.
A ContextConfig struct is a data structure that holds configuration of the Context.
A Delimiter struct represents a delimiter like '*' of the Markdown text.
A HeadingConfig struct is a data structure that holds configuration of the renderers related to headings.
A ParseConfig struct is a data structure that holds configuration of the Parser.Parse.
# Interfaces
ASTTransformer transforms entire Markdown document AST tree.
A BlockParser interface parses a block level element like Paragraph, List, Blockquote etc.
A CloseBlocker interface is a callback function that will be called when block is closed in the inline parsing.
A Context interface holds a information that are necessary to parse Markdown text.
A DelimiterProcessor interface provides a set of functions about Delimiter nodes.
A HeadingOption interface sets options for heading parsers.
An IDs interface is a collection of the element ids.
An InlineParser interface parses an inline level element like CodeSpan, Link etc.
An Option interface is a functional option type for the Parser.
A ParagraphTransformer transforms parsed Paragraph nodes.
A Parser interface parses Markdown text into AST nodes.
A Reference interface represents a link reference in Markdown text.
A SetOptioner interface sets the given option to the object.
# Type aliases
An Attributes is a collection of attributes.
ContextKey is a key that is used to set arbitrary values to the context.
An ContextOption is a functional option type for the Context.
OptionName is a name of parser options.
A ParseOption is a functional option type for the Parser.Parse.
State represents parser's state.