markdown

Documentation

Index

• func EscapeForLiteral(in string) string
• type Markdown
  • func NewMarkdown(topTitle string) *Markdown
  • func (m *Markdown) Bytes() []byte
  • func (m *Markdown) EndTableRow()
  • func (m *Markdown) Exact(text string)
  • func (m *Markdown) ExactBytes() []byte
  • func (m *Markdown) ExactText(text string)
  • func (m *Markdown) ExactTextf(format string, args ...any)
  • func (m *Markdown) NewOrderedListItem()
  • func (m *Markdown) NextTableColumn()
  • func (m *Markdown) OrderedListEnd()
  • func (m *Markdown) OrderedListStart()
  • func (m *Markdown) Text(text string)
  • func (m *Markdown) Textf(format string, args ...any)
  • func (m *Markdown) Title(level int, text string)
  • func (m *Markdown) UnlistedTitle(level int, text string)

Functions

func EscapeForLiteral

func EscapeForLiteral(in string) string

EscapeForLiteral escapes common characters so they render properly

Types

type Markdown

type Markdown struct {
	// contains filtered or unexported fields
}

func NewMarkdown

func NewMarkdown(topTitle string) *Markdown

func (*Markdown) Bytes

func (m *Markdown) Bytes() []byte

func (*Markdown) EndTableRow

func (m *Markdown) EndTableRow()

func (*Markdown) Exact

func (m *Markdown) Exact(text string)

func (*Markdown) ExactBytes

func (m *Markdown) ExactBytes() []byte

ExactBytes returns markdown with table of contents or title. Useful for embedding.

func (*Markdown) ExactText

func (m *Markdown) ExactText(text string)

func (*Markdown) ExactTextf

func (m *Markdown) ExactTextf(format string, args ...any)

func (*Markdown) NewOrderedListItem

func (m *Markdown) NewOrderedListItem()

func (*Markdown) NextTableColumn

func (m *Markdown) NextTableColumn()

func (*Markdown) OrderedListEnd

func (m *Markdown) OrderedListEnd()

func (*Markdown) OrderedListStart

func (m *Markdown) OrderedListStart()

func (*Markdown) Text

func (m *Markdown) Text(text string)

func (*Markdown) Textf

func (m *Markdown) Textf(format string, args ...any)

func (*Markdown) Title

func (m *Markdown) Title(level int, text string)

func (*Markdown) UnlistedTitle

func (m *Markdown) UnlistedTitle(level int, text string)