dot

Documentation

Index

• Constants
• Variables
• func Attr(id string, classes ...string) pandoc.Attr
• func AttrKVs(id string, kvs []pandoc.KV, classes ...string) pandoc.Attr
• func Blocks(b ...pandoc.Block) []pandoc.Block
• func BulletList(i ...[]pandoc.Block) *pandoc.BulletList
• func Citation(id string, mode pandoc.CitationMode, noteNum int, ...) *pandoc.Citation
• func Cite(c ...*pandoc.Citation) *pandoc.Cite
• func Code(attr pandoc.Attr, text string) *pandoc.Code
• func CodeBlock(attr pandoc.Attr, text string) *pandoc.CodeBlock
• func Div(attr pandoc.Attr, i ...pandoc.Block) *pandoc.Div
• func Emph(i ...pandoc.Inline) *pandoc.Emph
• func Filter[P any, E pandoc.Element, R pandoc.Element](elt E, fun func(P) ([]R, error)) (E, error)
• func Header(level int, attr pandoc.Attr, i ...pandoc.Inline) *pandoc.Header
• func HorizontalRule() pandoc.Block
• func Image(attr pandoc.Attr, url string, title string, i ...pandoc.Inline) *pandoc.Image
• func Index[E pandoc.Element, L pandoc.Element](lst []L) (int, E)
• func Index2[E1 pandoc.Element, E2 pandoc.Element, L pandoc.Element](lst []L) (int, E1, E2)
• func Index3[E1 pandoc.Element, E2 pandoc.Element, E3 pandoc.Element, L pandoc.Element](lst []L) (int, E1, E2, E3)
• func Inlines(i ...pandoc.Inline) []pandoc.Inline
• func InlinesToIdent(inlines []pandoc.Inline) string
• func KVs(kvs ...string) []pandoc.KV
• func LineBreak() pandoc.Inline
• func Link(attr pandoc.Attr, url string, title string, i ...pandoc.Inline) *pandoc.Link
• func Match[T pandoc.Element, E pandoc.Element](m T, e E) (T, bool)
• func Math(t pandoc.MathType, text string) *pandoc.Math
• func Note(i ...pandoc.Block) pandoc.Inline
• func Para(i ...pandoc.Inline) *pandoc.Para
• func Plain(i ...pandoc.Inline) *pandoc.Plain
• func Query[P any, E pandoc.Element](elt E, fun func(P))
• func QueryE[P any, E pandoc.Element](elt E, fun func(P) error) error
• func Quoted(t pandoc.QuoteType, i ...pandoc.Inline) *pandoc.Quoted
• func RawBlock(format string, text string) *pandoc.RawBlock
• func RawInline(format string, text string) *pandoc.RawInline
• func SmallCaps(i ...pandoc.Inline) *pandoc.SmallCaps
• func SoftBreak() pandoc.Inline
• func Space() pandoc.Inline
• func Span(attr pandoc.Attr, i ...pandoc.Inline) *pandoc.Span
• func Str(s string) pandoc.Inline
• func Strikeout(i ...pandoc.Inline) *pandoc.Strikeout
• func StringToIdent(s string) string
• func Strong(i ...pandoc.Inline) *pandoc.Strong
• func Subscript(i ...pandoc.Inline) *pandoc.Subscript
• func Superscript(i ...pandoc.Inline) *pandoc.Superscript
• func Underline(i ...pandoc.Inline) *pandoc.Underline

Constants

const (
	DoubleQuote = pandoc.DoubleQuote
	SingleQuote = pandoc.SingleQuote
)

const (
	NormalCitation = pandoc.NormalCitation
	SuppressAuthor = pandoc.SuppressAuthor
	AuthorInText   = pandoc.AuthorInText
)

const (
	DisplayMath = pandoc.DisplayMath
	InlineMath  = pandoc.InlineMath
)

Variables

var (
	Continue        = pandoc.Continue
	Skip            = pandoc.Skip
	Halt            = pandoc.Halt
	ReplaceContinue = pandoc.ReplaceContinue
	ReplaceSkip     = pandoc.ReplaceSkip
	ReplaceHalt     = pandoc.ReplaceHalt
)

var NoAttr = pandoc.Attr{}

Functions

func Attr

func Attr(id string, classes ...string) pandoc.Attr

func AttrKVs

func AttrKVs(id string, kvs []pandoc.KV, classes ...string) pandoc.Attr

func Blocks

func Blocks(b ...pandoc.Block) []pandoc.Block

func BulletList

func BulletList(i ...[]pandoc.Block) *pandoc.BulletList

func Citation

func Citation(id string, mode pandoc.CitationMode, noteNum int, prefix, suffix []pandoc.Inline) *pandoc.Citation

func Cite

func Cite(c ...*pandoc.Citation) *pandoc.Cite

Citation (list of inlines as citation prefix).

func Code

func Code(attr pandoc.Attr, text string) *pandoc.Code

Inline code (literal). The first argument is the span attributes.

func CodeBlock

func CodeBlock(attr pandoc.Attr, text string) *pandoc.CodeBlock

func Div

func Div(attr pandoc.Attr, i ...pandoc.Block) *pandoc.Div

func Emph

func Emph(i ...pandoc.Inline) *pandoc.Emph

Emphasized text (list of inlines)

func Filter

func Filter[P any, E pandoc.Element, R pandoc.Element](elt E, fun func(P) ([]R, error)) (E, error)

func Header

func Header(level int, attr pandoc.Attr, i ...pandoc.Inline) *pandoc.Header

func HorizontalRule

func HorizontalRule() pandoc.Block

Horizontal rule.

func Image

func Image(attr pandoc.Attr, url string, title string, i ...pandoc.Inline) *pandoc.Image

Image (list of inlines as alternate text).

func Index

func Index[E pandoc.Element, L pandoc.Element](lst []L) (int, E)

func Index2

func Index2[E1 pandoc.Element, E2 pandoc.Element, L pandoc.Element](lst []L) (int, E1, E2)

func Index3

func Index3[E1 pandoc.Element, E2 pandoc.Element, E3 pandoc.Element, L pandoc.Element](lst []L) (int, E1, E2, E3)

func Inlines

func Inlines(i ...pandoc.Inline) []pandoc.Inline

func InlinesToIdent

func InlinesToIdent(inlines []pandoc.Inline) string

func KVs

func KVs(kvs ...string) []pandoc.KV

func LineBreak

func LineBreak() pandoc.Inline

Hard line break

func Link

func Link(attr pandoc.Attr, url string, title string, i ...pandoc.Inline) *pandoc.Link

Link (list of inlines as link text).

func Match

func Match[T pandoc.Element, E pandoc.Element](m T, e E) (T, bool)

func Math

func Math(t pandoc.MathType, text string) *pandoc.Math

TeX math (literal). The first argument is the math type.

func Note

func Note(i ...pandoc.Block) pandoc.Inline

Footnote or endnote (list of blocks)

func Para

func Para(i ...pandoc.Inline) *pandoc.Para

func Plain

func Plain(i ...pandoc.Inline) *pandoc.Plain

func Query

func Query[P any, E pandoc.Element](elt E, fun func(P))

func QueryE

func QueryE[P any, E pandoc.Element](elt E, fun func(P) error) error

func Quoted

func Quoted(t pandoc.QuoteType, i ...pandoc.Inline) *pandoc.Quoted

Quoted text (list of inlines). The first argument is the quote type.

func RawBlock

func RawBlock(format string, text string) *pandoc.RawBlock

func RawInline

func RawInline(format string, text string) *pandoc.RawInline

Raw inline (literal). The first argument is the format the literal must be export in.

func SmallCaps

func SmallCaps(i ...pandoc.Inline) *pandoc.SmallCaps

Small capitals (list of inlines)

func SoftBreak

func SoftBreak() pandoc.Inline

Soft line break

func Space

func Space() pandoc.Inline

Inter-word space

func Span

func Span(attr pandoc.Attr, i ...pandoc.Inline) *pandoc.Span

Generic inline container with attributes.

func Str

func Str(s string) pandoc.Inline

Text (string)

func Strikeout

func Strikeout(i ...pandoc.Inline) *pandoc.Strikeout

Strikeout text (list of inlines)

func StringToIdent

func StringToIdent(s string) string

func Strong

func Strong(i ...pandoc.Inline) *pandoc.Strong

Strongly emphasized text (list of inlines)

func Subscript

func Subscript(i ...pandoc.Inline) *pandoc.Subscript

Subscripted text (list of inlines)

func Superscript

func Superscript(i ...pandoc.Inline) *pandoc.Superscript

Superscripted text (list of inlines)

func Underline

func Underline(i ...pandoc.Inline) *pandoc.Underline

Underlined text (list of inlines)