xcmd_mdfmt

Documentation

Index

• func NewRenderer(opt *Options) blackfriday.Renderer
• func Process(filename string, src []byte, opt *Options) ([]byte, error)
• type Options

Functions

func NewRenderer

func NewRenderer(opt *Options) blackfriday.Renderer

NewRenderer returns a Markdown renderer. If opt is nil the defaults are used.

func Process

func Process(filename string, src []byte, opt *Options) ([]byte, error)

Process formats Markdown. If opt is nil the defaults are used. Error can only occur when reading input from filename rather than src.

Types

type Options

type Options struct {
	// Terminal specifies if ANSI escape codes are emitted for styling.
	Terminal bool
}

Options specifies options for formatting.