# Packages
Package ast defines AST nodes that represents extension's elements.
# Functions
NewCJK returns a new extension with given options.
NewDefinitionDescriptionParser return a new parser.BlockParser that can parse definition description starts with ':'.
NewDefinitionListHTMLRenderer returns a new DefinitionListHTMLRenderer.
NewDefinitionListParser return a new parser.BlockParser that can parse PHP Markdown Extra Definition lists.
NewFootnote returns a new extension with given options.
NewFootnoteASTTransformer returns a new parser.ASTTransformer that insert a footnote list to the last of the document.
NewFootnoteBlockParser returns a new parser.BlockParser that can parse footnotes of the Markdown(PHP Markdown Extra) text.
NewFootnoteConfig returns a new Config with defaults.
NewFootnoteHTMLRenderer returns a new FootnoteHTMLRenderer.
NewFootnoteParser returns a new parser.InlineParser that can parse footnote links of the Markdown(PHP Markdown Extra) text.
NewLinkify creates a new [goldmark.Extender] that allow you to parse text that seems like a URL.
NewLinkifyParser return a new InlineParser can parse text that seems like a URL.
NewStrikethroughHTMLRenderer returns a new StrikethroughHTMLRenderer.
NewStrikethroughParser return a new InlineParser that parses strikethrough expressions.
NewTable returns a new extension with given options.
NewTableASTTransformer returns a parser.ASTTransformer for tables.
NewTableConfig returns a new Config with defaults.
NewTableHTMLRenderer returns a new TableHTMLRenderer.
NewTableParagraphTransformer returns a new ParagraphTransformer that can transform paragraphs into tables.
NewTaskCheckBoxHTMLRenderer returns a new TaskCheckBoxHTMLRenderer.
NewTaskCheckBoxParser returns a new InlineParser that can parse checkboxes in list items.
NewTypographer returns a new Extender that replaces punctuations with typographic entities.
NewTypographerParser return a new InlineParser that parses typographer expressions.
WithEastAsianLineBreaks is a functional option that indicates whether softline breaks between east asian wide characters should be ignored.
WithEscapedSpace is a functional option that indicates that a '\' escaped half-space(0x20) should not be rendered.
WithFootnoteBacklinkClass is a functional option that is a class for footnote backlinks.
WithFootnoteBacklinkHTML is an HTML content for footnote backlinks.
WithFootnoteBacklinkTitle is a functional option that is an optional title attribute for footnote backlinks.
WithFootnoteHTMLOptions is functional option that wraps goldmark HTMLRenderer options.
WithFootnoteIDPrefix is a functional option that is a prefix for the id attributes generated by footnotes.
WithFootnoteIDPrefixFunction is a functional option that is a prefix for the id attributes generated by footnotes.
WithFootnoteLinkClass is a functional option that is a class for footnote links.
WithFootnoteLinkTitle is a functional option that is an optional title attribute for footnote links.
WithLinkifyAllowedProtocols is a functional option that specify allowed protocols in autolinks.
WithLinkifyEmailRegexp is a functional otpion that specify a pattern of the email address.
WithLinkifyURLRegexp is a functional option that specify a pattern of the URL including a protocol.
WithLinkifyWWWRegexp is a functional option that specify a pattern of the URL without a protocol.
WithTableCellAlignMethod is a functional option that indicates how are table cells aligned in HTML format.
WithTableHTMLOptions is functional option that wraps goldmark HTMLRenderer options.
WithTypographicSubstitutions is a functional otpion that specify replacement text for punctuations.
# Constants
Apostrophe is ' .
EastAsianLineBreaksCSS3Draft is a style where soft line breaks are ignored even if only one side of the break is an east asian wide character.
EastAsianLineBreaksNone renders line breaks as it is.
EastAsianLineBreaksSimple is a style where soft line breaks are ignored if both sides of the break are east asian wide characters.
Ellipsis is ..
EmDash is --- .
EnDash is -- .
LeftAngleQuote is << .
LeftDoubleQuote is " .
LeftSingleQuote is ' .
RightAngleQuote is >> .
RightDoubleQuote is " .
RightSingleQuote is ' .
TableCellAlignAttribute renders alignments as an align attribute.
TableCellAlignDefault renders alignments by default method.
TableCellAlignNone does not care about alignments.
TableCellAlignStyle renders alignments as a style attribute.
# Variables
CJK is a goldmark extension that provides functionalities for CJK languages.
DefinitionDescriptionAttributeFilter defines attribute names which dd elements can have.
DefinitionList is an extension that allow you to use PHP Markdown Extra Definition lists.
DefinitionListAttributeFilter defines attribute names which dl elements can have.
DefinitionTermAttributeFilter defines attribute names which dd elements can have.
Footnote is an extension that allow you to use PHP Markdown Extra Footnotes.
GFM is an extension that provides Github Flavored markdown functionalities.
Linkify is an extension that allow you to parse text that seems like a URL.
Strikethrough is an extension that allow you to use strikethrough expression like '~~text~~' .
StrikethroughAttributeFilter defines attribute names which dd elements can have.
Table is an extension that allow you to use GFM tables .
TableAttributeFilter defines attribute names which table elements can have.
TableHeaderAttributeFilter defines attribute names which <thead> elements can have.
TableRowAttributeFilter defines attribute names which <tr> elements can have.
TableTdCellAttributeFilter defines attribute names which table <td> cells can have.
TableThCellAttributeFilter defines attribute names which table <th> cells can have.
TaskList is an extension that allow you to use GFM task lists.
Typographer is an extension that replaces punctuations with typographic entities.
# Structs
DefinitionListHTMLRenderer is a renderer.NodeRenderer implementation that renders DefinitionList nodes.
FootnoteConfig holds configuration values for the footnote extension.
FootnoteHTMLRenderer is a renderer.NodeRenderer implementation that renders FootnoteLink nodes.
An LinkifyConfig struct is a data structure that holds configuration of the Linkify extension.
StrikethroughHTMLRenderer is a renderer.NodeRenderer implementation that renders Strikethrough nodes.
TableConfig struct holds options for the extension.
TableHTMLRenderer is a renderer.NodeRenderer implementation that renders Table nodes.
TaskCheckBoxHTMLRenderer is a renderer.NodeRenderer implementation that renders checkboxes in list items.
An TypographerConfig struct is a data structure that holds configuration of the Typographer extension.
# Interfaces
FootnoteOption interface is a functional option interface for the extension.
A LinkifyOption interface sets options for the LinkifyOption.
TableOption interface is a functional option interface for the extension.
A TypographerOption interface sets options for the TypographerParser.
# Type aliases
A CJKOption sets options for CJK support mostly for HTML based renderers.
A EastAsianLineBreaks is a style of east asian line breaks.
TableCellAlignMethod indicates how are table cells aligned in HTML format.
TypographicPunctuation is a key of the punctuations that can be replaced with typographic entities.
TypographicSubstitutions is a list of the substitutions for the Typographer extension.