parser

package

Go to main page

Versions in this module

v1

v1.8.6

Sep 3, 2026

v1.8.5

Jul 28, 2026

v1.8.4

Jul 12, 2026

v1.8.3

Jul 12, 2026

v1.8.2

Mar 25, 2026

v1.8.1

Mar 24, 2026

v1.8.0

Mar 24, 2026

v1.7.17

Mar 19, 2026

v1.7.16

Jan 6, 2026 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.15

Jan 5, 2026 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.14

Jan 4, 2026 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.13

Jul 22, 2025 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.12

May 17, 2025 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.11

Apr 27, 2025 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.10

Apr 15, 2025 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.9

Apr 14, 2025 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.8

Oct 16, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.7

Oct 15, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.6

Oct 12, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.5

Oct 12, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.4

Jun 25, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.3

Jun 23, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.2

Jun 14, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.1

Apr 3, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.7.0

Feb 2, 2024 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.6.0

Oct 28, 2023 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.5.6

Aug 15, 2023 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type State

+ const None

v1.5.5

Jul 23, 2023 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.5.4

Feb 2, 2023 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.5.3

Nov 12, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.5.2

Sep 25, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.5.1

Sep 25, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type Config

+ EscapedSpace bool

type Option

+ func WithEscapedSpace() Option

v1.5.0

Sep 24, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.15

Sep 19, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.14

Sep 2, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.13

Jul 9, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.12

Apr 23, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.11

Mar 20, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.10

Mar 12, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.9

Mar 8, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.8

Mar 5, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.7

Feb 18, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.6

Feb 12, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.5

Feb 8, 2022 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.4

Nov 14, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.3

Nov 8, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.2

Oct 21, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.1

Sep 12, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.4.0

Jul 4, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.9

Jun 27, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.8

Jun 17, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.7

May 16, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.6

May 15, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.5

Apr 13, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.4

Apr 10, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.3

Mar 20, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.2

Feb 7, 2021 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.3.1

Dec 26, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type Context

+ ComputeIfAbsent func(ContextKey, func() interface{}) interface{}

v1.3.0

Dec 13, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.2.1

Jul 30, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.2.0

Jul 21, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.33

Jul 10, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.32

Jun 4, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.31

May 22, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.30

Apr 16, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.29

Apr 15, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.28

Apr 13, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.27

Mar 31, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.26

Mar 25, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.25

Mar 8, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.24

Mar 1, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.23

Feb 18, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.22

Jan 27, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.21

Jan 11, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.20

Jan 1, 2020 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.19

Dec 27, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.18

Dec 22, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type Context

+ IsInLinkLabel func() bool

v1.1.17

Dec 20, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.16

Dec 18, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.15

Dec 18, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.14

Dec 8, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.12

Dec 2, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.11

Dec 2, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

+ type ContextConfig struct

+ IDs IDs

+ type ContextOption func(*ContextConfig)

+ func WithIDs(ids IDs) ContextOption

v1.1.10

Dec 1, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.9

Nov 29, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.8

Nov 29, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.7

Nov 26, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.6

Nov 25, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.5

Nov 24, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.4

Nov 19, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.3

Nov 16, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.2

Nov 10, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.1

Oct 31, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.1.0

Aug 30, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type BlockParser

+ Trigger func() []byte

type Context

+ func NewConcurrentContext(delegate Context) Context

+ Root func() Context

type ParseConfig

+ Workers int

type ParseOption

+ func WithWorkers(num int) ParseOption

v1.0.10

Aug 28, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

+ type Attribute struct

+ Name []byte

+ Value interface{}

+ type Attributes []Attribute

+ func (as Attributes) Find(name []byte) (interface{}, bool)

v1.0.9

Aug 7, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

type BlockParser

+ func NewThematicBreakParser() BlockParser

+ type ThematicBreakParser struct

+ func (b *ThematicBreakParser) CanAcceptIndentedLine() bool

+ func (b *ThematicBreakParser) CanInterruptParagraph() bool

+ func (b *ThematicBreakParser) Close(node ast.Node, reader text.Reader, pc Context)

+ func (b *ThematicBreakParser) Continue(node ast.Node, reader text.Reader, pc Context) State

+ func (b *ThematicBreakParser) Open(parent ast.Node, reader text.Reader, pc Context) (ast.Node, State)

v1.0.8

Jul 25, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

+ func ParseAttributes(reader text.Reader) (map[string]interface{}, bool)

type Context

+ BlockIndent func() int

+ SetBlockIndent func(int)

type State

+ const RequireParagraph

v1.0.7

May 30, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.0.6

May 23, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.0.5

May 16, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

v1.0.4

May 16, 2019 GO-2026-5320

GO-2026-5320: Cross-site Scripting (XSS) in github.com/yuin/goldmark

Changes in this version

+ var LinkReferenceParagraphTransformer = &linkReferenceParagraphTransformer

+ func DefaultBlockParsers() []util.PrioritizedValue

+ func DefaultInlineParsers() []util.PrioritizedValue

+ func DefaultParagraphTransformers() []util.PrioritizedValue

+ func ProcessDelimiters(bottom ast.Node, pc Context)

+ type ASTTransformer interface

+ Transform func(node *ast.Document, reader text.Reader, pc Context)

+ type Block struct

+ Node ast.Node

+ Parser BlockParser

+ type BlockParser interface

+ CanAcceptIndentedLine func() bool

+ CanInterruptParagraph func() bool

+ Close func(node ast.Node, reader text.Reader, pc Context)

+ Continue func(node ast.Node, reader text.Reader, pc Context) State

+ Open func(parent ast.Node, reader text.Reader, pc Context) (ast.Node, State)

+ func NewATXHeadingParser(opts ...HeadingOption) BlockParser

+ func NewBlockquoteParser() BlockParser

+ func NewCodeBlockParser() BlockParser

+ func NewFencedCodeBlockParser() BlockParser

+ func NewHTMLBlockParser(opts ...HTMLOption) BlockParser

+ func NewListItemParser() BlockParser

+ func NewListParser() BlockParser

+ func NewParagraphParser() BlockParser

+ func NewSetextHeadingParser(opts ...HeadingOption) BlockParser

+ func NewThemanticBreakParser() BlockParser

+ type CloseBlocker interface

+ CloseBlock func(parent ast.Node, block text.Reader, pc Context)

+ type Config struct

+ ASTTransformers util.PrioritizedSlice

+ BlockParsers util.PrioritizedSlice

+ InlineParsers util.PrioritizedSlice

+ Options map[OptionName]interface{}

+ ParagraphTransformers util.PrioritizedSlice

+ func NewConfig() *Config

+ type Context interface

+ AddReference func(Reference)

+ BlockOffset func() int

+ ClearDelimiters func(bottom ast.Node)

+ FirstDelimiter func() *Delimiter

+ Get func(ContextKey) interface{}

+ IDs func() IDs

+ LastDelimiter func() *Delimiter

+ LastOpenedBlock func() Block

+ OpenedBlocks func() []Block

+ PushDelimiter func(delimiter *Delimiter)

+ Reference func(label string) (Reference, bool)

+ References func() []Reference

+ RemoveDelimiter func(d *Delimiter)

+ Set func(ContextKey, interface{})

+ SetBlockOffset func(int)

+ SetOpenedBlocks func([]Block)

+ String func() string

+ func NewContext() Context

+ type ContextKey int

+ var ContextKeyMax ContextKey

+ func NewContextKey() ContextKey

+ type Delimiter struct

+ CanClose bool

+ CanOpen bool

+ Char byte

+ Length int

+ NextDelimiter *Delimiter

+ OriginalLength int

+ PreviousDelimiter *Delimiter

+ Processor DelimiterProcessor

+ Segment text.Segment

+ func NewDelimiter(canOpen, canClose bool, length int, char byte, processor DelimiterProcessor) *Delimiter

+ func ScanDelimiter(line []byte, before rune, min int, processor DelimiterProcessor) *Delimiter

+ func (d *Delimiter) CalcComsumption(closer *Delimiter) int

+ func (d *Delimiter) ConsumeCharacters(n int)

+ func (d *Delimiter) Dump(source []byte, level int)

+ func (d *Delimiter) Inline()

+ func (d *Delimiter) Kind() ast.NodeKind

+ func (d *Delimiter) Text(source []byte) []byte

+ type DelimiterProcessor interface

+ CanOpenCloser func(opener, closer *Delimiter) bool

+ IsDelimiter func(byte) bool

+ OnMatch func(consumes int) ast.Node

+ type HTMLConfig struct

+ FilterTags map[string]bool

+ func (b *HTMLConfig) SetOption(name OptionName, value interface{})

+ type HTMLOption interface

+ SetHTMLOption func(*HTMLConfig)

+ func WithFilterTags(names ...string) HTMLOption

+ type HeadingConfig struct

+ Attribute bool

+ AutoHeadingID bool

+ func (b *HeadingConfig) SetOption(name OptionName, value interface{})

+ type HeadingOption interface

+ SetHeadingOption func(*HeadingConfig)

+ func WithAutoHeadingID() HeadingOption

+ func WithHeadingAttribute() HeadingOption

+ type IDs interface

+ Generate func(value, prefix []byte) []byte

+ Put func(value []byte)

+ type InlineParser interface

+ Parse func(parent ast.Node, block text.Reader, pc Context) ast.Node

+ Trigger func() []byte

+ func NewAutoLinkParser() InlineParser

+ func NewCodeSpanParser() InlineParser

+ func NewEmphasisParser() InlineParser

+ func NewLinkParser() InlineParser

+ func NewRawHTMLParser(opts ...HTMLOption) InlineParser

+ type Option interface

+ SetParserOption func(*Config)

+ func WithASTTransformers(ps ...util.PrioritizedValue) Option

+ func WithAttribute() Option

+ func WithBlockParsers(bs ...util.PrioritizedValue) Option

+ func WithInlineParsers(bs ...util.PrioritizedValue) Option

+ func WithOption(name OptionName, value interface{}) Option

+ func WithParagraphTransformers(ps ...util.PrioritizedValue) Option

+ type OptionName string

+ type ParagraphTransformer interface

+ Transform func(node *ast.Paragraph, reader text.Reader, pc Context)

+ type ParseConfig struct

+ Context Context

+ type ParseOption func(c *ParseConfig)

+ func WithContext(context Context) ParseOption

+ type Parser interface

+ AddOptions func(...Option)

+ Parse func(reader text.Reader, opts ...ParseOption) ast.Node

+ func NewParser(options ...Option) Parser

+ type Reference interface

+ Destination func() []byte

+ Label func() []byte

+ String func() string

+ Title func() []byte

+ func NewReference(label, destination, title []byte) Reference

+ type SetOptioner interface

+ SetOption func(name OptionName, value interface{})

+ type State int

+ const Close

+ const Continue

+ const HasChildren

+ const NoChildren

Other modules containing this package

github.com/yuin/goldmark/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL