gemtext

Documentation

Index

• type Builder
  • func NewBuilder() Builder
  • func (b *Builder) AddHeader1Line(text string) *Builder
  • func (b *Builder) AddHeader2Line(text string) *Builder
  • func (b *Builder) AddHeader3Line(text string) *Builder
  • func (b *Builder) AddLinkLine(url string, name ...string) *Builder
  • func (b *Builder) AddPreformattedText(text string) *Builder
  • func (b *Builder) AddQuoteLine(text string) *Builder
  • func (b *Builder) AddTextLine(line string) *Builder
  • func (b *Builder) AddUnorderedList(items []string) *Builder
  • func (b *Builder) Get() string

Types

type Builder

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

A Builder is an object capable of building a Gemtext document

func NewBuilder

func NewBuilder() Builder

NewBuilder creates a new Builder

func (*Builder) AddHeader1Line

func (b *Builder) AddHeader1Line(text string) *Builder

AddHeader1Line adds a top level header line

func (*Builder) AddHeader2Line

func (b *Builder) AddHeader2Line(text string) *Builder

AddHeader2Line adds a secondary level header line

func (*Builder) AddHeader3Line

func (b *Builder) AddHeader3Line(text string) *Builder

AddHeader3Line adds a tertiary level header line

func (*Builder) AddLinkLine

func (b *Builder) AddLinkLine(url string, name ...string) *Builder

AddLinkLine adds a new link line.

While more than two args can be passed to it, any additional arguments will be ignored for the time being

func (*Builder) AddPreformattedText

func (b *Builder) AddPreformattedText(text string) *Builder

AddPreformattedText adds a block of preformatted text

func (*Builder) AddQuoteLine

func (b *Builder) AddQuoteLine(text string) *Builder

AddQuoteLine adds a blockquoted line

func (*Builder) AddTextLine

func (b *Builder) AddTextLine(line string) *Builder

AddTextLine adds a new text line (i.e. no additional formatting) to the Builder

func (*Builder) AddUnorderedList

func (b *Builder) AddUnorderedList(items []string) *Builder

AddUnorderedList adds an unordered list

func (*Builder) Get

func (b *Builder) Get() string

Get gets the Gemtext content of the Builder