mdtable

Documentation

Overview

Package mdtable helps construct markdown tables.

Index

• type Alignment
• type Builder
  • func (b *Builder) AddRow(row []string) *Builder
  • func (b *Builder) Build() string
  • func (b *Builder) BuildCSV() string
  • func (b *Builder) SetAlignment(colAlignments []Alignment) *Builder
  • func (b *Builder) SetHeader(cells []string) *Builder

Types

type Alignment

type Alignment string

Alignment specifies a column alignment.

const (
	DefaultAlignment Alignment = ""
	Left             Alignment = ":--"
	Right            Alignment = "--:"
	Center           Alignment = ":-:"
)

Valid Alignment values.

type Builder

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

Builder helps construct a Markdown table.

func (*Builder) AddRow

func (b *Builder) AddRow(row []string) *Builder

AddRow adds a given markdown literals as contents of a row.

func (*Builder) Build

func (b *Builder) Build() string

func (*Builder) BuildCSV

func (b *Builder) BuildCSV() string

BuildCSV returns the table as a CSV.

func (*Builder) SetAlignment

func (b *Builder) SetAlignment(colAlignments []Alignment) *Builder

SetAlignment sets the alignment of the columns.

func (*Builder) SetHeader

func (b *Builder) SetHeader(cells []string) *Builder

SetHeader sets the header cell contents of the table.