man

Documentation

Overview

The package man outputs man pages from mmmark markdown.

Index

• type Flags
• type Renderer
  • func NewRenderer(opts RendererOptions) *Renderer
  • func (r *Renderer) RenderFooter(w io.Writer, node ast.Node)
  • func (r *Renderer) RenderHeader(w io.Writer, _ ast.Node)
  • func (r *Renderer) RenderNode(w io.Writer, node ast.Node, entering bool) ast.WalkStatus
• type RendererOptions

Types

type Flags

type Flags int

Flags control optional behavior of Markdown renderer.

const (
	FlagsNone   Flags = 0
	ManFragment Flags = 1 << iota // Don't generate a complete document

	CommonFlags Flags = FlagsNone
)

HTML renderer configuration options.

type Renderer

type Renderer struct {
	Title *mast.Title
	// 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, node ast.Node)

func (*Renderer) RenderHeader

func (r *Renderer) RenderHeader(w 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

	Language lang.Lang // Output language for the document.

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

	// Comments is a list of comments the renderer should detect when
	// parsing code blocks and detecting callouts.
	Comments [][]byte
}

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