markdown

Documentation

Index

• func RenderLink(name, link string) string
• type Table
  • func NewTable(alignment string, headers ...string) *Table
  • func (t *Table) AddRow(items ...string)
  • func (t *Table) Columns() int
  • func (t *Table) Rows() int
  • func (t *Table) String() string
• type Writer
  • func (md *Writer) EmptyLine()
  • func (md *Writer) String() string
  • func (md *Writer) WriteHeader(h string)
  • func (md *Writer) WriteLine(s string)
  • func (md *Writer) WriteListItem(item string)
  • func (md *Writer) WriteSubheader(sh string)
  • func (md *Writer) WriteTable(table Table)
  • func (md *Writer) WriteTitle(h string)
  • func (md *Writer) WriteTopLevelHeader(h string)

Functions

func RenderLink

func RenderLink(name, link string) string

RenderLink returns a rendered markdown link

Types

type Table

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

Table describes a table in a markdown document

func NewTable

func NewTable(alignment string, headers ...string) *Table

NewTable creates a new table with given alignments and headers

func (*Table) AddRow

func (t *Table) AddRow(items ...string)

AddRow adds a new row to the table

func (*Table) Columns

func (t *Table) Columns() int

Columns returns the number of columns in this table

func (*Table) Rows

func (t *Table) Rows() int

Rows returns the number of rows in this table

func (*Table) String

func (t *Table) String() string

String outputs the markdown table to a string

type Writer

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

Writer is a writer to write contents in markdown format

func (*Writer) EmptyLine

func (md *Writer) EmptyLine()

EmptyLine inserts an empty line to the markdown document

func (*Writer) String

func (md *Writer) String() string

String outputs the markdown document as a string

func (*Writer) WriteHeader

func (md *Writer) WriteHeader(h string)

WriteHeader writes a header to the markdown document

func (*Writer) WriteLine

func (md *Writer) WriteLine(s string)

WriteLine writes a line to the markdown document

func (*Writer) WriteListItem

func (md *Writer) WriteListItem(item string)

WriteListItem writes a line in a list

func (*Writer) WriteSubheader

func (md *Writer) WriteSubheader(sh string)

WriteSubheader writes a sub-header to the markdown document

func (*Writer) WriteTable

func (md *Writer) WriteTable(table Table)

WriteTable writes a table to the markdown document

func (*Writer) WriteTitle

func (md *Writer) WriteTitle(h string)

WriteTitle writes a title to the markdown document

func (*Writer) WriteTopLevelHeader

func (md *Writer) WriteTopLevelHeader(h string)

WriteTopLevelHeader writes a header to the markdown document