markdown

Documentation

Overview

The package markdown outputs normalized mmark markdown. It useful to have as a mmarkfmt.

Index

• Variables
• func Space(length int) []byte
• type Flags
• type Renderer
  • func NewRenderer(opts RendererOptions) *Renderer
  • func (r *Renderer) RenderFooter(w io.Writer, _ ast.Node)
  • func (r *Renderer) RenderHeader(_ io.Writer, _ ast.Node)
  • func (r *Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus
• type RendererOptions

Variables

var (
	Aside = []byte("A> ")
	Quote = []byte("> ")
)

Functions

func Space

func Space(length int) []byte

Types

type Flags

type Flags int

Flags control optional behavior of Markdown renderer.

const (
	FlagsNone Flags = 0

	CommonFlags Flags = FlagsNone
)

HTML renderer configuration options.

type Renderer

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

Renderer implements Renderer interface for Markdown output.

func NewRenderer

func NewRenderer(opts RendererOptions) *Renderer

NewRenderer creates and configures an Renderer object, which satisfies the Renderer interface.

func (*Renderer) RenderFooter

func (r *Renderer) RenderFooter(w io.Writer, _ ast.Node)

func (*Renderer) RenderHeader

func (r *Renderer) RenderHeader(_ io.Writer, _ ast.Node)

func (*Renderer) RenderNode

func (r *Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus

RenderNode renders a markdown node to markdown.

type RendererOptions

type RendererOptions struct {
	Flags Flags // Flags allow customizing this renderer's behavior

	TextWidth int

	// if set, called at the start of RenderNode(). Allows replacing rendering of some nodes
	RenderNodeHook html.RenderNodeFunc
}

RendererOptions is a collection of supplementary parameters tweaking the behavior of various parts of Markdown renderer.