markdown

Documentation

Index

• func New() goldmark.Markdown
• func NewLinkModifierRenderer(opts ...renderer.Option) renderer.Renderer
• func Parse(markdown goldmark.Markdown, source []byte) (ast.Node, error)
• func WithLinkResolver(linkResolver ResolveLink) renderer.Option
• type Renderer
• type ResolveLink

Functions

func New

func New() goldmark.Markdown

New creates a markdown parser

func NewLinkModifierRenderer

func NewLinkModifierRenderer(opts ...renderer.Option) renderer.Renderer

NewLinkModifierRenderer returns a new linkModifierRenderer with given renderer options.

func Parse

func Parse(markdown goldmark.Markdown, source []byte) (ast.Node, error)

Parse markdown content and returns AST node or error

func WithLinkResolver

func WithLinkResolver(linkResolver ResolveLink) renderer.Option

WithLinkResolver is a functional option that allow you to set the ResolveLink to the renderer.

Types

type Renderer

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

Renderer holds document source, buffer writer, info for indents and some nodes for rendering a markdown

type ResolveLink

type ResolveLink func(dest string, isEmbeddable bool) (string, error)

ResolveLink type defines function for modifying link destination dest - original destination isEmbeddable - if true, raw destination required