markdown

Jun 26, 2026

Changes in this version

+ const DocumentVersion

+ type Document struct

+ Filename string

+ Metadata map[string]any

+ Root Node

+ Version int

+ func Parse(source []byte, opts ...Option) (*Document, error)

+ func ParseFile(filename string, opts ...Option) (*Document, error)

+ func ParseString(source string, opts ...Option) (*Document, error)

+ func (d *Document) ANSI() string

+ func (d *Document) ClickyDocument() formatters.ClickyDocument

+ func (d *Document) HTML() string

+ func (d *Document) Markdown() string

+ func (d *Document) String() string

+ type Node struct

+ Align string

+ Attributes map[string]string

+ Checked *bool

+ Children []Node

+ Href string

+ ID string

+ Items []Node

+ Kind string

+ Language string

+ Level int

+ LineEnd int

+ LineStart int

+ Ordered bool

+ RawHTML string

+ Severity string

+ Source string

+ Text string

+ Title string

+ func (n Node) ANSI() string

+ func (n Node) ClickyNode() formatters.ClickyNode

+ func (n Node) HTML() string

+ func (n Node) Markdown() string

+ func (n Node) String() string

+ type Option func(*Options)

+ func WithAdmonitions(enabled bool) Option

+ func WithFilename(filename string) Option

+ func WithFootnotes(enabled bool) Option

+ func WithFrontmatter(enabled bool) Option

+ func WithGFM(enabled bool) Option

+ func WithPreserveHTML(enabled bool) Option

+ func WithSourceSpans(enabled bool) Option

+ type Options struct

+ Admonitions bool

+ Filename string

+ Footnotes bool

+ Frontmatter bool

+ GFM bool

+ PreserveHTML bool

+ SourceSpans bool