markdown

Documentation

Index

• func AsString(n content.Node) (string, error)
• func EscapeBlockRef(prev rune, r rune) bool
• func EscapeLinkTitle(prev rune, r rune) bool
• func EscapeLinkURL(prev rune, r rune) bool
• func EscapeMacroQuotedArgument(prev rune, r rune) bool
• func EscapeNone(rune, rune) bool
• func EscapePotentialMarkdown(prev rune, r rune) bool
• func EscapeString(str string, f EscapeFunc) string
• func EscapeWikiLink(prev rune, r rune) bool
• func Parse(src []byte) (*content.Block, error)
• func ParseString(src string) (*content.Block, error)
• func Write(n content.Node, out io.Writer) error
• type EscapeFunc
• type Output
  • func NewWriter(out io.Writer) *Output
  • func (w *Output) Write(n content.Node) error

Functions

func AsString

func AsString(n content.Node) (string, error)

func EscapeBlockRef

func EscapeBlockRef(prev rune, r rune) bool

func EscapeLinkTitle

func EscapeLinkTitle(prev rune, r rune) bool

func EscapeLinkURL

func EscapeLinkURL(prev rune, r rune) bool

func EscapeMacroQuotedArgument

func EscapeMacroQuotedArgument(prev rune, r rune) bool

func EscapeNone

func EscapeNone(rune, rune) bool

func EscapePotentialMarkdown

func EscapePotentialMarkdown(prev rune, r rune) bool

func EscapeString

func EscapeString(str string, f EscapeFunc) string

func EscapeWikiLink

func EscapeWikiLink(prev rune, r rune) bool

func Parse

func Parse(src []byte) (*content.Block, error)

func ParseString

func ParseString(src string) (*content.Block, error)

func Write

func Write(n content.Node, out io.Writer) error

Types

type EscapeFunc

type EscapeFunc func(rune, rune) bool

type Output

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

Output is used to write Markdown to an output buffer. It will help keep track of list indentation and when to add newlines.

func NewWriter

func NewWriter(out io.Writer) *Output

NewWriter creates a new Markdown writer.

func (*Output) Write

func (w *Output) Write(n content.Node) error