package extension

Import Path
	github.com/yuin/goldmark/extension (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	      definition_list.go
	      footnote.go
	      gfm.go
	      linkify.go
	      strikethrough.go
	      table.go
	      tasklist.go
	      typographer.go
Package-Level Type Names (total 54, in which 16 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type DefinitionListHTMLRenderer (struct)
		DefinitionListHTMLRenderer is a renderer.NodeRenderer implementation that
		renders DefinitionList nodes.

		Fields (total 5, all are exported)
			Config html.Config
			Config.HardWraps bool
			Config.Unsafe bool
			Config.Writer html.Writer
			Config.XHTML bool
		Methods (total 5, in which 2 are exported)
			(*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
				RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.NodeRenderer.SetOption.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*T) renderDefinitionDescription(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderDefinitionList(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderDefinitionTerm(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/renderer.NodeRenderer
			*T : github.com/yuin/goldmark/renderer.SetOptioner

	 type FootnoteConfig (struct)
		FootnoteConfig holds configuration values for the footnote extension.

		Link* and Backlink* configurations have some variables:
		Occurrances of “^^” in the string will be replaced by the
		corresponding footnote number in the HTML output.
		Occurrances of “%%” will be replaced by a number for the
		reference (footnotes can have multiple references).

		Fields (total 12, all are exported)
			BacklinkClass []byte
				BacklinkClass is a class for footnote backlinks.

			BacklinkHTML []byte
				BacklinkHTML is an HTML content for footnote backlinks.

			BacklinkTitle []byte
				BacklinkTitle is an optional title attribute for footnote backlinks.

			Config html.Config
			Config.HardWraps bool
			Config.Unsafe bool
			Config.Writer html.Writer
			Config.XHTML bool
			IDPrefix []byte
				IDPrefix is a prefix for the id attributes generated by footnotes.

			IDPrefixFunction func(gast.Node) []byte
				IDPrefix is a function that determines the id attribute for given Node.

			LinkClass []byte
				LinkClass is a class for footnote links.

			LinkTitle []byte
				LinkTitle is an optional title attribute for footnote links.

		Methods (only one, which is exported)
			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.SetOptioner.

		Implements (at least one exported)
			*T : github.com/yuin/goldmark/renderer.SetOptioner
		As Outputs Of (at least one exported)
			func NewFootnoteConfig() FootnoteConfig
		As Inputs Of (at least one exported)
			func FootnoteOption.SetFootnoteOption(*FootnoteConfig)

	 type FootnoteHTMLRenderer (struct)
		FootnoteHTMLRenderer is a renderer.NodeRenderer implementation that
		renders FootnoteLink nodes.

		Fields (total 13, all are exported)
			FootnoteConfig FootnoteConfig
			FootnoteConfig.BacklinkClass []byte
				BacklinkClass is a class for footnote backlinks.

			FootnoteConfig.BacklinkHTML []byte
				BacklinkHTML is an HTML content for footnote backlinks.

			FootnoteConfig.BacklinkTitle []byte
				BacklinkTitle is an optional title attribute for footnote backlinks.

			FootnoteConfig.Config html.Config
			FootnoteConfig.Config.HardWraps bool
			FootnoteConfig.Config.Unsafe bool
			FootnoteConfig.Config.Writer html.Writer
			FootnoteConfig.Config.XHTML bool
			FootnoteConfig.IDPrefix []byte
				IDPrefix is a prefix for the id attributes generated by footnotes.

			FootnoteConfig.IDPrefixFunction func(gast.Node) []byte
				IDPrefix is a function that determines the id attribute for given Node.

			FootnoteConfig.LinkClass []byte
				LinkClass is a class for footnote links.

			FootnoteConfig.LinkTitle []byte
				LinkTitle is an optional title attribute for footnote links.

		Methods (total 7, in which 2 are exported)
			(*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
				RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.SetOptioner.

			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) idPrefix(node gast.Node) []byte
			(*T) renderFootnote(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderFootnoteBacklink(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderFootnoteLink(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderFootnoteList(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/renderer.NodeRenderer
			*T : github.com/yuin/goldmark/renderer.SetOptioner

	 type FootnoteOption (interface)
		FootnoteOption interface is a functional option interface for the extension.

		Methods (total 2, both are exported)
			( T) SetConfig(*renderer.Config)
			( T) SetFootnoteOption(*FootnoteConfig)
				SetFootnoteOption sets given option to the extension.

		Implemented By (at least 8, none are exported)
			/* 8+ unexporteds ... *//* 8+ unexporteds: */
			*withFootnoteBacklinkClass
			*withFootnoteBacklinkHTML
			*withFootnoteBacklinkTitle
			*withFootnoteHTMLOptions
			*withFootnoteIDPrefix
			*withFootnoteIDPrefixFunction
			*withFootnoteLinkClass
			*withFootnoteLinkTitle
		Implements (at least one exported)
			 T : github.com/yuin/goldmark/renderer.Option
		As Outputs Of (at least 8, all are exported)
			func WithFootnoteBacklinkClass(a []byte) FootnoteOption
			func WithFootnoteBacklinkHTML(a []byte) FootnoteOption
			func WithFootnoteBacklinkTitle(a []byte) FootnoteOption
			func WithFootnoteHTMLOptions(opts ...html.Option) FootnoteOption
			func WithFootnoteIDPrefix(a []byte) FootnoteOption
			func WithFootnoteIDPrefixFunction(a func(gast.Node) []byte) FootnoteOption
			func WithFootnoteLinkClass(a []byte) FootnoteOption
			func WithFootnoteLinkTitle(a []byte) FootnoteOption
		As Inputs Of (at least 2, both are exported)
			func NewFootnote(opts ...FootnoteOption) goldmark.Extender
			func NewFootnoteHTMLRenderer(opts ...FootnoteOption) renderer.NodeRenderer

	 type LinkifyConfig (struct)
		An LinkifyConfig struct is a data structure that holds configuration of the
		Linkify extension.

		Fields (total 4, all are exported)
			AllowedProtocols [][]byte
			EmailRegexp *regexp.Regexp
			URLRegexp *regexp.Regexp
			WWWRegexp *regexp.Regexp
		Methods (only one, which is exported)
			(*T) SetOption(name parser.OptionName, value interface{})
				SetOption implements SetOptioner.

		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.SetOptioner
		As Inputs Of (at least one exported)
			func LinkifyOption.SetLinkifyOption(*LinkifyConfig)

	 type LinkifyOption (interface)
		A LinkifyOption interface sets options for the LinkifyOption.

		Methods (total 2, both are exported)
			( T) SetLinkifyOption(*LinkifyConfig)
			( T) SetParserOption(*parser.Config)
		Implemented By (at least 4, none are exported)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			*withLinkifyAllowedProtocols
			*withLinkifyEmailRegexp
			*withLinkifyURLRegexp
			*withLinkifyWWWRegexp
		Implements (at least one exported)
			 T : github.com/yuin/goldmark/parser.Option
		As Outputs Of (at least 4, all are exported)
			func WithLinkifyAllowedProtocols(value [][]byte) LinkifyOption
			func WithLinkifyEmailRegexp(value *regexp.Regexp) LinkifyOption
			func WithLinkifyURLRegexp(value *regexp.Regexp) LinkifyOption
			func WithLinkifyWWWRegexp(value *regexp.Regexp) LinkifyOption
		As Inputs Of (at least 2, both are exported)
			func NewLinkify(opts ...LinkifyOption) goldmark.Extender
			func NewLinkifyParser(opts ...LinkifyOption) parser.InlineParser

	 type StrikethroughHTMLRenderer (struct)
		StrikethroughHTMLRenderer is a renderer.NodeRenderer implementation that
		renders Strikethrough nodes.

		Fields (total 5, all are exported)
			Config html.Config
			Config.HardWraps bool
			Config.Unsafe bool
			Config.Writer html.Writer
			Config.XHTML bool
		Methods (total 3, in which 2 are exported)
			(*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
				RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.NodeRenderer.SetOption.

			/* one unexported ... *//* one unexported: */
			(*T) renderStrikethrough(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/renderer.NodeRenderer
			*T : github.com/yuin/goldmark/renderer.SetOptioner

	 type TableCellAlignMethod int (basic type)
		TableCellAlignMethod indicates how are table cells aligned in HTML format.indicates how are table cells aligned in HTML format.

		As Inputs Of (at least one exported)
			func WithTableCellAlignMethod(a TableCellAlignMethod) TableOption
		As Types Of (total 4, all are exported)
			const TableCellAlignAttribute
			const TableCellAlignDefault
			const TableCellAlignNone
			const TableCellAlignStyle

	 type TableConfig (struct)
		TableConfig struct holds options for the extension.

		Fields (total 6, all are exported)
			Config html.Config
			Config.HardWraps bool
			Config.Unsafe bool
			Config.Writer html.Writer
			Config.XHTML bool
			TableCellAlignMethod TableCellAlignMethod
				TableCellAlignMethod indicates how are table celss aligned.

		Methods (only one, which is exported)
			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.SetOptioner.

		Implements (at least one exported)
			*T : github.com/yuin/goldmark/renderer.SetOptioner
		As Outputs Of (at least one exported)
			func NewTableConfig() TableConfig
		As Inputs Of (at least one exported)
			func TableOption.SetTableOption(*TableConfig)

	 type TableHTMLRenderer (struct)
		TableHTMLRenderer is a renderer.NodeRenderer implementation that
		renders Table nodes.

		Fields (total 7, all are exported)
			TableConfig TableConfig
			TableConfig.Config html.Config
			TableConfig.Config.HardWraps bool
			TableConfig.Config.Unsafe bool
			TableConfig.Config.Writer html.Writer
			TableConfig.Config.XHTML bool
			TableConfig.TableCellAlignMethod TableCellAlignMethod
				TableCellAlignMethod indicates how are table celss aligned.

		Methods (total 6, in which 2 are exported)
			(*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
				RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.SetOptioner.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) renderTable(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderTableCell(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderTableHeader(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			(*T) renderTableRow(w util.BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/renderer.NodeRenderer
			*T : github.com/yuin/goldmark/renderer.SetOptioner

	 type TableOption (interface)
		TableOption interface is a functional option interface for the extension.

		Methods (total 2, both are exported)
			( T) SetConfig(*renderer.Config)
			( T) SetTableOption(*TableConfig)
				SetTableOption sets given option to the extension.

		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*withTableCellAlignMethod
			*withTableHTMLOptions
		Implements (at least one exported)
			 T : github.com/yuin/goldmark/renderer.Option
		As Outputs Of (at least 2, both are exported)
			func WithTableCellAlignMethod(a TableCellAlignMethod) TableOption
			func WithTableHTMLOptions(opts ...html.Option) TableOption
		As Inputs Of (at least 2, both are exported)
			func NewTable(opts ...TableOption) goldmark.Extender
			func NewTableHTMLRenderer(opts ...TableOption) renderer.NodeRenderer

	 type TaskCheckBoxHTMLRenderer (struct)
		TaskCheckBoxHTMLRenderer is a renderer.NodeRenderer implementation that
		renders checkboxes in list items.

		Fields (total 5, all are exported)
			Config html.Config
			Config.HardWraps bool
			Config.Unsafe bool
			Config.Writer html.Writer
			Config.XHTML bool
		Methods (total 3, in which 2 are exported)
			(*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
				RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

			(*T) SetOption(name renderer.OptionName, value interface{})
				SetOption implements renderer.NodeRenderer.SetOption.

			/* one unexported ... *//* one unexported: */
			(*T) renderTaskCheckBox(w util.BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/renderer.NodeRenderer
			*T : github.com/yuin/goldmark/renderer.SetOptioner

	 type TypographerConfig (struct)
		An TypographerConfig struct is a data structure that holds configuration of the
		Typographer extension.

		Fields (only one, which is exported)
			Substitutions [][]byte
		Methods (only one, which is exported)
			(*T) SetOption(name parser.OptionName, value interface{})
				SetOption implements SetOptioner.

		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.SetOptioner
		As Inputs Of (at least one exported)
			func TypographerOption.SetTypographerOption(*TypographerConfig)

	 type TypographerOption (interface)
		A TypographerOption interface sets options for the TypographerParser.

		Methods (total 2, both are exported)
			( T) SetParserOption(*parser.Config)
			( T) SetTypographerOption(*TypographerConfig)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*withTypographicSubstitutions
		Implements (at least one exported)
			 T : github.com/yuin/goldmark/parser.Option
		As Outputs Of (at least one exported)
			func WithTypographicSubstitutions(values map[TypographicPunctuation][]byte) TypographerOption
		As Inputs Of (at least 2, both are exported)
			func NewTypographer(opts ...TypographerOption) goldmark.Extender
			func NewTypographerParser(opts ...TypographerOption) parser.InlineParser

	 type TypographicPunctuation int (basic type)
		TypographicPunctuation is a key of the punctuations that can be replaced with
		typographic entities.

		As Inputs Of (at least one exported)
			func WithTypographicSubstitutions(values map[TypographicPunctuation][]byte) TypographerOption
		As Types Of (total 11, in which 10 are exported)
			const Apostrophe
			const Ellipsis
			const EmDash
			const EnDash
			const LeftAngleQuote
			const LeftDoubleQuote
			const LeftSingleQuote
			const RightAngleQuote
			const RightDoubleQuote
			const RightSingleQuote
			/* one unexported ... *//* one unexported: */
			const typographicPunctuationMax

	 type TypographicSubstitutions (map)
		TypographicSubstitutions is a list of the substitutions for the Typographer extension.


	/* 38 unexporteds ... *//* 38 unexporteds: */
	 type definitionDescriptionParser (struct)

		Methods (total 6, all are exported)
			(*T) CanAcceptIndentedLine() bool
			(*T) CanInterruptParagraph() bool
			(*T) Close(node gast.Node, reader text.Reader, pc parser.Context)
			(*T) Continue(node gast.Node, reader text.Reader, pc parser.Context) parser.State
			(*T) Open(parent gast.Node, reader text.Reader, pc parser.Context) (gast.Node, parser.State)
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.BlockParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultDefinitionDescriptionParser *definitionDescriptionParser

	 type definitionList (struct)

		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var DefinitionList *definitionList

	 type definitionListParser (struct)

		Methods (total 6, all are exported)
			(*T) CanAcceptIndentedLine() bool
			(*T) CanInterruptParagraph() bool
			(*T) Close(node gast.Node, reader text.Reader, pc parser.Context)
			(*T) Continue(node gast.Node, reader text.Reader, pc parser.Context) parser.State
			(*T) Open(parent gast.Node, reader text.Reader, pc parser.Context) (gast.Node, parser.State)
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.BlockParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultDefinitionListParser *definitionListParser

	 type escapedPipeCell (struct)

		Fields (total 3, all are exported)
			Cell *ast.TableCell
			Pos []int
			Transformed bool

	 type footnote (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options []FootnoteOption
		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var Footnote *footnote

	 type footnoteASTTransformer (struct)

		Methods (only one, which is exported)
			(*T) Transform(node *gast.Document, reader text.Reader, pc parser.Context)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.ASTTransformer
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultFootnoteASTTransformer *footnoteASTTransformer

	 type footnoteBlockParser (struct)

		Methods (total 6, all are exported)
			(*T) CanAcceptIndentedLine() bool
			(*T) CanInterruptParagraph() bool
			(*T) Close(node gast.Node, reader text.Reader, pc parser.Context)
			(*T) Continue(node gast.Node, reader text.Reader, pc parser.Context) parser.State
			(*T) Open(parent gast.Node, reader text.Reader, pc parser.Context) (gast.Node, parser.State)
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.BlockParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultFootnoteBlockParser *footnoteBlockParser

	 type footnoteParser (struct)

		Methods (total 2, both are exported)
			(*T) Parse(parent gast.Node, block text.Reader, pc parser.Context) gast.Node
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.InlineParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultFootnoteParser *footnoteParser

	 type gfm (struct)

		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var GFM *gfm

	 type linkify (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options []LinkifyOption
		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var Linkify *linkify

	 type linkifyParser (struct)

		Fields (total 5, all are exported)
			LinkifyConfig LinkifyConfig
			LinkifyConfig.AllowedProtocols [][]byte
			LinkifyConfig.EmailRegexp *regexp.Regexp
			LinkifyConfig.URLRegexp *regexp.Regexp
			LinkifyConfig.WWWRegexp *regexp.Regexp
		Methods (total 4, all are exported)
			(*T) CloseBlock(parent ast.Node, pc parser.Context)
			(*T) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node
			(*T) SetOption(name parser.OptionName, value interface{})
				SetOption implements SetOptioner.

			(*T) Trigger() []byte
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/parser.InlineParser
			*T : github.com/yuin/goldmark/parser.SetOptioner

	 type strikethrough (struct)

		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var Strikethrough *strikethrough

	 type strikethroughDelimiterProcessor (struct)

		Methods (total 3, all are exported)
			(*T) CanOpenCloser(opener, closer *parser.Delimiter) bool
			(*T) IsDelimiter(b byte) bool
			(*T) OnMatch(consumes int) gast.Node
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.DelimiterProcessor
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultStrikethroughDelimiterProcessor *strikethroughDelimiterProcessor

	 type strikethroughParser (struct)

		Methods (total 3, all are exported)
			(*T) CloseBlock(parent gast.Node, pc parser.Context)
			(*T) Parse(parent gast.Node, block text.Reader, pc parser.Context) gast.Node
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.InlineParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultStrikethroughParser *strikethroughParser

	 type table (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options []TableOption
		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var Table *table

	 type tableASTTransformer (struct)

		Methods (only one, which is exported)
			(*T) Transform(node *gast.Document, reader text.Reader, pc parser.Context)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.ASTTransformer
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultTableASTTransformer *tableASTTransformer

	 type tableParagraphTransformer (struct)

		Methods (total 3, in which 1 are exported)
			(*T) Transform(node *gast.Paragraph, reader text.Reader, pc parser.Context)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) parseDelimiter(segment text.Segment, reader text.Reader) []ast.Alignment
			(*T) parseRow(segment text.Segment, alignments []ast.Alignment, isHeader bool, reader text.Reader, pc parser.Context) *ast.TableRow
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.ParagraphTransformer
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultTableParagraphTransformer *tableParagraphTransformer

	 type taskCheckBoxParser (struct)

		Methods (total 3, all are exported)
			(*T) CloseBlock(parent gast.Node, pc parser.Context)
			(*T) Parse(parent gast.Node, block text.Reader, pc parser.Context) gast.Node
			(*T) Trigger() []byte
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.InlineParser
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultTaskCheckBoxParser *taskCheckBoxParser

	 type taskList (struct)

		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var TaskList *taskList

	 type typographer (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			options []TypographerOption
		Methods (only one, which is exported)
			(*T) Extend(m goldmark.Markdown)
		Implements (at least one exported)
			*T : github.com/yuin/goldmark.Extender
		As Types Of (only one, which is exported)
			  var Typographer *typographer

	 type typographerDelimiterProcessor (struct)

		Methods (total 3, all are exported)
			(*T) CanOpenCloser(opener, closer *parser.Delimiter) bool
			(*T) IsDelimiter(b byte) bool
			(*T) OnMatch(consumes int) gast.Node
		Implements (at least one exported)
			*T : github.com/yuin/goldmark/parser.DelimiterProcessor
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultTypographerDelimiterProcessor *typographerDelimiterProcessor

	 type typographerParser (struct)

		Fields (total 2, both are exported)
			TypographerConfig TypographerConfig
			TypographerConfig.Substitutions [][]byte
		Methods (total 4, all are exported)
			(*T) CloseBlock(parent gast.Node, pc parser.Context)
			(*T) Parse(parent gast.Node, block text.Reader, pc parser.Context) gast.Node
			(*T) SetOption(name parser.OptionName, value interface{})
				SetOption implements SetOptioner.

			(*T) Trigger() []byte
		Implements (at least 2, both are exported)
			*T : github.com/yuin/goldmark/parser.InlineParser
			*T : github.com/yuin/goldmark/parser.SetOptioner

	 type unclosedCounter (struct)

		Fields (total 2, both are exported)
			Double int
			Single int
		Methods (only one, which is exported)
			(*T) Reset()
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func getUnclosedCounter(pc parser.Context) *unclosedCounter

	 type withFootnoteBacklinkClass (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteBacklinkHTML (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteBacklinkTitle (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteHTMLOptions (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []html.Option
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteIDPrefix (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteIDPrefixFunction (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value func(gast.Node) []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteLinkClass (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withFootnoteLinkTitle (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []byte
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetFootnoteOption(c *FootnoteConfig)
		Implements (at least 2, both are exported)
			*T : FootnoteOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withLinkifyAllowedProtocols (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value [][]byte
		Methods (total 2, both are exported)
			(*T) SetLinkifyOption(p *LinkifyConfig)
			(*T) SetParserOption(c *parser.Config)
		Implements (at least 2, both are exported)
			*T : LinkifyOption
			*T : github.com/yuin/goldmark/parser.Option

	 type withLinkifyEmailRegexp (struct)
		WithLinkifyWWWRegexp is a functional otpion that specify
		a pattern of the email address.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value *regexp.Regexp
		Methods (total 2, both are exported)
			(*T) SetLinkifyOption(p *LinkifyConfig)
			(*T) SetParserOption(c *parser.Config)
		Implements (at least 2, both are exported)
			*T : LinkifyOption
			*T : github.com/yuin/goldmark/parser.Option

	 type withLinkifyURLRegexp (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value *regexp.Regexp
		Methods (total 2, both are exported)
			(*T) SetLinkifyOption(p *LinkifyConfig)
			(*T) SetParserOption(c *parser.Config)
		Implements (at least 2, both are exported)
			*T : LinkifyOption
			*T : github.com/yuin/goldmark/parser.Option

	 type withLinkifyWWWRegexp (struct)
		WithLinkifyWWWRegexp is a functional option that specify
		a pattern of the URL without a protocol.
		This pattern must start with 'www.' .

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value *regexp.Regexp
		Methods (total 2, both are exported)
			(*T) SetLinkifyOption(p *LinkifyConfig)
			(*T) SetParserOption(c *parser.Config)
		Implements (at least 2, both are exported)
			*T : LinkifyOption
			*T : github.com/yuin/goldmark/parser.Option

	 type withTableCellAlignMethod (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value TableCellAlignMethod
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetTableOption(c *TableConfig)
		Implements (at least 2, both are exported)
			*T : TableOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withTableHTMLOptions (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []html.Option
		Methods (total 2, both are exported)
			(*T) SetConfig(c *renderer.Config)
			(*T) SetTableOption(c *TableConfig)
		Implements (at least 2, both are exported)
			*T : TableOption
			*T : github.com/yuin/goldmark/renderer.Option

	 type withTypographicSubstitutions (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value [][]byte
		Methods (total 2, both are exported)
			(*T) SetParserOption(c *parser.Config)
			(*T) SetTypographerOption(p *TypographerConfig)
		Implements (at least 2, both are exported)
			*T : TypographerOption
			*T : github.com/yuin/goldmark/parser.Option


Package-Level Functions (total 41, in which 37 are exported)

	 func NewDefinitionDescriptionParser() parser.BlockParser
		NewDefinitionDescriptionParser return a new parser.BlockParser that
		can parse definition description starts with ':'.

	 func NewDefinitionListHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
		NewDefinitionListHTMLRenderer returns a new DefinitionListHTMLRenderer.

	 func NewDefinitionListParser() parser.BlockParser
		NewDefinitionListParser return a new parser.BlockParser that
		can parse PHP Markdown Extra Definition lists.

	 func NewFootnote(opts ...FootnoteOption) goldmark.Extender
		NewFootnote returns a new extension with given options.

	 func NewFootnoteASTTransformer() parser.ASTTransformer
		NewFootnoteASTTransformer returns a new parser.ASTTransformer that
		insert a footnote list to the last of the document.

	 func NewFootnoteBlockParser() parser.BlockParser
		NewFootnoteBlockParser returns a new parser.BlockParser that can parse
		footnotes of the Markdown(PHP Markdown Extra) text.

	 func NewFootnoteConfig() FootnoteConfig
		NewFootnoteConfig returns a new Config with defaults.

	 func NewFootnoteHTMLRenderer(opts ...FootnoteOption) renderer.NodeRenderer
		NewFootnoteHTMLRenderer returns a new FootnoteHTMLRenderer.

	 func NewFootnoteParser() parser.InlineParser
		NewFootnoteParser returns a new parser.InlineParser that can parse
		footnote links of the Markdown(PHP Markdown Extra) text.

	 func NewLinkify(opts ...LinkifyOption) goldmark.Extender
	 func NewLinkifyParser(opts ...LinkifyOption) parser.InlineParser
		NewLinkifyParser return a new InlineParser can parse
		text that seems like a URL.

	 func NewStrikethroughHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
		NewStrikethroughHTMLRenderer returns a new StrikethroughHTMLRenderer.

	 func NewStrikethroughParser() parser.InlineParser
		NewStrikethroughParser return a new InlineParser that parses
		strikethrough expressions.

	 func NewTable(opts ...TableOption) goldmark.Extender
		NewTable returns a new extension with given options.

	 func NewTableASTTransformer() parser.ASTTransformer
		NewTableASTTransformer returns a parser.ASTTransformer for tables.

	 func NewTableConfig() TableConfig
		NewTableConfig returns a new Config with defaults.

	 func NewTableHTMLRenderer(opts ...TableOption) renderer.NodeRenderer
		NewTableHTMLRenderer returns a new TableHTMLRenderer.

	 func NewTableParagraphTransformer() parser.ParagraphTransformer
		NewTableParagraphTransformer returns  a new ParagraphTransformer
		that can transform paragraphs into tables.

	 func NewTaskCheckBoxHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
		NewTaskCheckBoxHTMLRenderer returns a new TaskCheckBoxHTMLRenderer.

	 func NewTaskCheckBoxParser() parser.InlineParser
		NewTaskCheckBoxParser returns a new  InlineParser that can parse
		checkboxes in list items.
		This parser must take precedence over the parser.LinkParser.

	 func NewTypographer(opts ...TypographerOption) goldmark.Extender
		NewTypographer returns a new Extender that replaces punctuations with typographic entities.

	 func NewTypographerParser(opts ...TypographerOption) parser.InlineParser
		NewTypographerParser return a new InlineParser that parses
		typographer expressions.

	 func WithFootnoteBacklinkClass(a []byte) FootnoteOption
		WithFootnoteBacklinkClass is a functional option that is a class for footnote backlinks.

	 func WithFootnoteBacklinkHTML(a []byte) FootnoteOption
		WithFootnoteBacklinkHTML is an HTML content for footnote backlinks.

	 func WithFootnoteBacklinkTitle(a []byte) FootnoteOption
		WithFootnoteBacklinkTitle is a functional option that is an optional title attribute for footnote backlinks.

	 func WithFootnoteHTMLOptions(opts ...html.Option) FootnoteOption
		WithFootnoteHTMLOptions is functional option that wraps goldmark HTMLRenderer options.

	 func WithFootnoteIDPrefix(a []byte) FootnoteOption
		WithFootnoteIDPrefix is a functional option that is a prefix for the id attributes generated by footnotes.

	 func WithFootnoteIDPrefixFunction(a func(gast.Node) []byte) FootnoteOption
		WithFootnoteIDPrefixFunction is a functional option that is a prefix for the id attributes generated by footnotes.

	 func WithFootnoteLinkClass(a []byte) FootnoteOption
		WithFootnoteLinkClass is a functional option that is a class for footnote links.

	 func WithFootnoteLinkTitle(a []byte) FootnoteOption
		WithFootnoteLinkTitle is a functional option that is an optional title attribute for footnote links.

	 func WithLinkifyAllowedProtocols(value [][]byte) LinkifyOption
		WithLinkifyAllowedProtocols is a functional option that specify allowed
		protocols in autolinks. Each protocol must end with ':' like
		'http:' .

	 func WithLinkifyEmailRegexp(value *regexp.Regexp) LinkifyOption
	 func WithLinkifyURLRegexp(value *regexp.Regexp) LinkifyOption
		WithLinkifyURLRegexp is a functional option that specify
		a pattern of the URL including a protocol.

	 func WithLinkifyWWWRegexp(value *regexp.Regexp) LinkifyOption
	 func WithTableCellAlignMethod(a TableCellAlignMethod) TableOption
		WithTableCellAlignMethod is a functional option that indicates how are table cells aligned in HTML format.

	 func WithTableHTMLOptions(opts ...html.Option) TableOption
		WithTableHTMLOptions is functional option that wraps goldmark HTMLRenderer options.

	 func WithTypographicSubstitutions(values map[TypographicPunctuation][]byte) TypographerOption
		WithTypographicSubstitutions is a functional otpion that specify replacement text
		for punctuations.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 func applyFootnoteTemplate(b []byte, index, refCount int) []byte
	 func getUnclosedCounter(pc parser.Context) *unclosedCounter
	 func isTableDelim(bs []byte) bool
	 func newDefaultSubstitutions() [][]byte
Package-Level Variables (total 43, in which 17 are exported)

	  var DefinitionDescriptionAttributeFilter util.BytesFilter
		DefinitionDescriptionAttributeFilter defines attribute names which dd elements can have.

	  var DefinitionList *definitionList
		DefinitionList is an extension that allow you to use PHP Markdown Extra Definition lists.

	  var DefinitionListAttributeFilter util.BytesFilter
		DefinitionListAttributeFilter defines attribute names which dl elements can have.

	  var DefinitionTermAttributeFilter util.BytesFilter
		DefinitionTermAttributeFilter defines attribute names which dd elements can have.

	  var Footnote *footnote
		Footnote is an extension that allow you to use PHP Markdown Extra Footnotes.

	  var GFM *gfm
		GFM is an extension that provides Github Flavored markdown functionalities.

	  var Linkify *linkify
		Linkify is an extension that allow you to parse text that seems like a URL.

	  var Strikethrough *strikethrough
		Strikethrough is an extension that allow you to use strikethrough expression like '~~text~~' .

	  var StrikethroughAttributeFilter util.BytesFilter
		StrikethroughAttributeFilter defines attribute names which dd elements can have.

	  var Table *table
		Table is an extension that allow you to use GFM tables .

	  var TableAttributeFilter util.BytesFilter
		TableAttributeFilter defines attribute names which table elements can have.

	  var TableHeaderAttributeFilter util.BytesFilter
		TableHeaderAttributeFilter defines attribute names which <thead> elements can have.

	  var TableRowAttributeFilter util.BytesFilter
		TableRowAttributeFilter defines attribute names which <tr> elements can have.

	  var TableTdCellAttributeFilter util.BytesFilter
		TableTdCellAttributeFilter defines attribute names which table <td> cells can have.

	  var TableThCellAttributeFilter util.BytesFilter
		TableThCellAttributeFilter defines attribute names which table <th> cells can have.

	  var TaskList *taskList
		TaskList is an extension that allow you to use GFM task lists.

	  var Typographer *typographer
		Typographer is an extension that replaces punctuations with typographic entities.

	/* 26 unexporteds ... *//* 26 unexporteds: */
	  var defaultDefinitionDescriptionParser *definitionDescriptionParser
	  var defaultDefinitionListParser *definitionListParser
	  var defaultFootnoteASTTransformer *footnoteASTTransformer
	  var defaultFootnoteBlockParser *footnoteBlockParser
	  var defaultFootnoteParser *footnoteParser
	  var defaultStrikethroughDelimiterProcessor *strikethroughDelimiterProcessor
	  var defaultStrikethroughParser *strikethroughParser
	  var defaultTableASTTransformer *tableASTTransformer
	  var defaultTableParagraphTransformer *tableParagraphTransformer
	  var defaultTaskCheckBoxParser *taskCheckBoxParser
	  var defaultTypographerDelimiterProcessor *typographerDelimiterProcessor
	  var domainWWW []byte
	  var escapedPipeCellListKey parser.ContextKey
	  var footnoteLinkListKey parser.ContextKey
	  var footnoteListKey parser.ContextKey
	  var protoFTP []byte
	  var protoHTTP []byte
	  var protoHTTPS []byte
	  var tableDelimCenter *regexp.Regexp
	  var tableDelimLeft *regexp.Regexp
	  var tableDelimNone *regexp.Regexp
	  var tableDelimRight *regexp.Regexp
	  var taskListRegexp *regexp.Regexp
	  var uncloseCounterKey parser.ContextKey
	  var urlRegexp *regexp.Regexp
	  var wwwURLRegxp *regexp.Regexp
Package-Level Constants (total 28, in which 14 are exported)

	const Apostrophe TypographicPunctuation = 10
		Apostrophe is '

	const Ellipsis TypographicPunctuation = 7
		Ellipsis is ...

	const EmDash TypographicPunctuation = 6
		EmDash is ---

	const EnDash TypographicPunctuation = 5
		EnDash is --

	const LeftAngleQuote TypographicPunctuation = 8
		LeftAngleQuote is <<

	const LeftDoubleQuote TypographicPunctuation = 3
		LeftDoubleQuote is "

	const LeftSingleQuote TypographicPunctuation = 1
		LeftSingleQuote is '

	const RightAngleQuote TypographicPunctuation = 9
		RightAngleQuote is >>

	const RightDoubleQuote TypographicPunctuation = 4
		RightDoubleQuote is "

	const RightSingleQuote TypographicPunctuation = 2
		RightSingleQuote is '

	const TableCellAlignAttribute TableCellAlignMethod = 1
		TableCellAlignAttribute renders alignments as an align attribute.

	const TableCellAlignDefault TableCellAlignMethod = 0
		TableCellAlignDefault renders alignments by default method.
		With XHTML, alignments are rendered as an align attribute.
		With HTML5, alignments are rendered as a style attribute.

	const TableCellAlignNone TableCellAlignMethod = 3
		TableCellAlignNone does not care about alignments.
		If you using classes or other styles, you can add these attributes
		in an ASTTransformer.

	const TableCellAlignStyle TableCellAlignMethod = 2
		TableCellAlignStyle renders alignments as a style attribute.

	/* 14 unexporteds ... *//* 14 unexporteds: */
	const optFootnoteBacklinkClass renderer.OptionName = "FootnoteBacklinkClass"
	const optFootnoteBacklinkHTML renderer.OptionName = "FootnoteBacklinkHTML"
	const optFootnoteBacklinkTitle renderer.OptionName = "FootnoteBacklinkTitle"
	const optFootnoteIDPrefix renderer.OptionName = "FootnoteIDPrefix"
	const optFootnoteIDPrefixFunction renderer.OptionName = "FootnoteIDPrefixFunction"
	const optFootnoteLinkClass renderer.OptionName = "FootnoteLinkClass"
	const optFootnoteLinkTitle renderer.OptionName = "FootnoteLinkTitle"
	const optLinkifyAllowedProtocols parser.OptionName = "LinkifyAllowedProtocols"
	const optLinkifyEmailRegexp parser.OptionName = "LinkifyEmailRegexp"
	const optLinkifyURLRegexp parser.OptionName = "LinkifyURLRegexp"
	const optLinkifyWWWRegexp parser.OptionName = "LinkifyWWWRegexp"
	const optTableCellAlignMethod renderer.OptionName = "TableTableCellAlignMethod"
	const optTypographicSubstitutions parser.OptionName = "TypographicSubstitutions"
	const typographicPunctuationMax TypographicPunctuation = 11

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.