markdown

Documentation

Overview

Package renderer renders the given AST to certain formats.

Index

• type Option
  • func WithSoftWraps() Option
  • func WithUnderlineHeadings() Option
• type Renderer
  • func NewRenderer() *Renderer
  • func (mr *Renderer) AddMarkdownOptions(opts ...Option)
  • func (mr *Renderer) AddOptions(...renderer.Option)
  • func (mr *Renderer) Render(w io.Writer, source []byte, node ast.Node) error

Types

type Option

type Option func(r *Renderer)

func WithSoftWraps

func WithSoftWraps() Option

WithSoftWraps allows you to wrap lines even on soft line breaks.

func WithUnderlineHeadings

func WithUnderlineHeadings() Option

type Renderer

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

Renderer allows to render markdown AST into markdown bytes in consistent format. Render is reusable across Renders, it holds configuration only.

func NewRenderer

func NewRenderer() *Renderer

func (*Renderer) AddMarkdownOptions

func (mr *Renderer) AddMarkdownOptions(opts ...Option)

func (*Renderer) AddOptions

func (mr *Renderer) AddOptions(...renderer.Option)

func (*Renderer) Render

func (mr *Renderer) Render(w io.Writer, source []byte, node ast.Node) error

Render renders the given AST node to the given buffer with the given Renderer. NOTE: This is the entry point used by Goldmark.