richdoc

package module

Go to main page

Versions in this module

v0

v0.6.0

Oct 4, 2026

v0.5.1

Oct 4, 2026

v0.5.0

Oct 4, 2026

Changes in this version

type Cell

+ Blocks []Block

+ func (c Cell) Content() []Block

type Table

+ Caption []Inline

v0.4.0

Sep 28, 2026

Changes in this version

type BlockQuote

+ Classes []string

type Code

+ Classes []string

type CodeBlock

+ Classes []string

type Image

+ Align Alignment

+ Classes []string

+ Height string

+ Scale int

+ Width string

type List

+ Classes []string

type Paragraph

+ Classes []string

type Table

+ Classes []string

v0.3.0

Aug 30, 2026

Changes in this version

type Cell

+ ColSpan int

+ RowSpan int

v0.2.0

Aug 20, 2026

Changes in this version

+ type Anchor struct

+ ID string

+ Inlines []Inline

+ func Mark(id string, inlines ...Inline) Anchor

+ type CrossRef struct

+ Inlines []Inline

+ Kind RefKind

+ Target string

+ func Cite(target string, inlines ...Inline) CrossRef

+ func Ref(target string, inlines ...Inline) CrossRef

+ type Footnote struct

+ Blocks []Block

+ func Note(blocks ...Block) Footnote

type Heading

+ ID string

+ type RefKind int

+ const RefCite

+ const RefLabel

v0.1.0

Aug 19, 2026

Changes in this version

+ func PlainText(d *Document) string

+ func Walk(d *Document, v Visitor)

+ type Alignment int

+ const AlignCenter

+ const AlignDefault

+ const AlignLeft

+ const AlignRight

+ type Block interface

+ type BlockQuote struct

+ Blocks []Block

+ type Builder struct

+ func New() *Builder

+ func (b *Builder) Add(blocks ...Block) *Builder

+ func (b *Builder) CodeBlock(language, text string) *Builder

+ func (b *Builder) Doc() *Document

+ func (b *Builder) H(level int, inlines ...Inline) *Builder

+ func (b *Builder) HR() *Builder

+ func (b *Builder) MathBlock(tex string) *Builder

+ func (b *Builder) Meta(key, value string) *Builder

+ func (b *Builder) OList(start int, tight bool, items ...ListItem) *Builder

+ func (b *Builder) P(inlines ...Inline) *Builder

+ func (b *Builder) Quote(blocks ...Block) *Builder

+ func (b *Builder) RawBlock(format, text string) *Builder

+ func (b *Builder) Table(align []Alignment, header []Cell, rows [][]Cell) *Builder

+ func (b *Builder) UList(tight bool, items ...ListItem) *Builder

+ type Cell struct

+ Inlines []Inline

+ func Td(inlines ...Inline) Cell

+ type Code struct

+ Value string

+ func Mono(value string) Code

+ type CodeBlock struct

+ Language string

+ Text string

+ type Document struct

+ Blocks []Block

+ Meta map[string]string

+ func Clone(d *Document) *Document

+ type Emph struct

+ Inlines []Inline

+ func Italic(inlines ...Inline) Emph

+ type Heading struct

+ Inlines []Inline

+ Level int

+ type Image struct

+ Alt string

+ Title string

+ URL string

+ func Img(url, alt, title string) Image

+ type Inline interface

+ type LineBreak struct

+ func Br() LineBreak

+ type Link struct

+ Inlines []Inline

+ Title string

+ URL string

+ func Href(url, title string, inlines ...Inline) Link

+ type List struct

+ Items []ListItem

+ Ordered bool

+ Start int

+ Tight bool

+ type ListItem struct

+ Blocks []Block

+ func Item(blocks ...Block) ListItem

+ type Math struct

+ TeX string

+ func InlineMath(tex string) Math

+ type MathBlock struct

+ TeX string

+ type Paragraph struct

+ Inlines []Inline

+ type RawBlock struct

+ Format string

+ Text string

+ type RawInline struct

+ Format string

+ Text string

+ func RawI(format, text string) RawInline

+ type Strikethrough struct

+ Inlines []Inline

+ func Strike(inlines ...Inline) Strikethrough

+ type Strong struct

+ Inlines []Inline

+ func Bold(inlines ...Inline) Strong

+ type Table struct

+ Align []Alignment

+ Header []Cell

+ Rows [][]Cell

+ type Text struct

+ Value string

+ func Txt(value string) Text

+ type ThematicBreak struct

+ type Visitor interface

+ Enter func(node any) (descend bool)

+ Leave func(node any)

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