text

Documentation

Index

• func DocumentFooter(out *bytes.Buffer)
• func DoubleEmphasis(out *bytes.Buffer, text []byte)
• func Emphasis(out *bytes.Buffer, text []byte)
• func Entity(out *bytes.Buffer, entity []byte)
• func Header(out *bytes.Buffer, text func() bool, level int, id string)
• func Link(out *bytes.Buffer, link []byte, title []byte, content []byte)
• func ListItem(out *bytes.Buffer, text []byte, flags int)
• func NormalText(out *bytes.Buffer, text []byte)
• func Paragraph(maximumLineLength int) renderer.TextFuncFunc
• func RawHtmlTag(out *bytes.Buffer, tag []byte)
• func Renderer(maximumLineLength int) *renderer.Customizable

Functions

func DocumentFooter

func DocumentFooter(out *bytes.Buffer)

func DoubleEmphasis

func DoubleEmphasis(out *bytes.Buffer, text []byte)

func Emphasis

func Emphasis(out *bytes.Buffer, text []byte)

func Entity

func Entity(out *bytes.Buffer, entity []byte)

func Header

func Header(out *bytes.Buffer, text func() bool, level int, id string)

func Link

func Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

func ListItem

func ListItem(out *bytes.Buffer, text []byte, flags int)

func NormalText

func NormalText(out *bytes.Buffer, text []byte)

func Paragraph

func Paragraph(maximumLineLength int) renderer.TextFuncFunc

func RawHtmlTag

func RawHtmlTag(out *bytes.Buffer, tag []byte)

func Renderer

func Renderer(maximumLineLength int) *renderer.Customizable

Renderer returns a Markdown renderer that emits plain text. This can be used to prepare a Markdown document for communication channels like chat messaging or email. To wrap at a certain amount of characters, set maximumLineLength to a value greater than 0. The renderer will take a best effort approach to try and make sure lines break before the specified line length.