markdown

Documentation

Index

• func Bold(value string) string
• func Code(value string) string
• func LinkHeader(name, reference string) string
• type Align
• type Markdown
  • func NewMarkdown() *Markdown
  • func (markdown *Markdown) Bold(value string)
  • func (markdown *Markdown) CodeBlock(value string)
  • func (markdown *Markdown) EmptyLine()
  • func (markdown *Markdown) Header1(value string)
  • func (markdown *Markdown) Header2(value string)
  • func (markdown *Markdown) Line(value string)
  • func (markdown *Markdown) ListItem(value string)
  • func (markdown *Markdown) Paragraph(value string)
  • func (markdown *Markdown) String() string
• type Table
  • func NewTable() *Table
  • func (table *Table) AddColumn(name string, align Align)
  • func (table *Table) AddRow(row ...string)
  • func (table *Table) ColWidth(colIndex int) int
  • func (table *Table) String() string

Functions

func Bold

func Bold(value string) string

func Code

func Code(value string) string

func LinkHeader

func LinkHeader(name, reference string) string

Types

type Align

type Align string

const (
	Left   Align = "left"
	Center Align = "center"
	Right  Align = "right"
)

type Markdown

type Markdown struct {
	Buffer *bytes.Buffer
}

func NewMarkdown

func NewMarkdown() *Markdown

func (*Markdown) Bold

func (markdown *Markdown) Bold(value string)

func (*Markdown) CodeBlock

func (markdown *Markdown) CodeBlock(value string)

func (*Markdown) EmptyLine

func (markdown *Markdown) EmptyLine()

func (*Markdown) Header1

func (markdown *Markdown) Header1(value string)

func (*Markdown) Header2

func (markdown *Markdown) Header2(value string)

func (*Markdown) Line

func (markdown *Markdown) Line(value string)

func (*Markdown) ListItem

func (markdown *Markdown) ListItem(value string)

func (*Markdown) Paragraph

func (markdown *Markdown) Paragraph(value string)

func (*Markdown) String

func (markdown *Markdown) String() string

type Table

type Table struct {
	Header []string
	Align  []Align
	Rows   [][]string
}

func NewTable

func NewTable() *Table

func (*Table) AddColumn

func (table *Table) AddColumn(name string, align Align)

func (*Table) AddRow

func (table *Table) AddRow(row ...string)

func (*Table) ColWidth

func (table *Table) ColWidth(colIndex int) int

func (*Table) String

func (table *Table) String() string