callout

type Callout ¶

type Callout struct {
	ast.BaseBlock
	Title string
	// contains filtered or unexported fields
}

A Callout struct represents a GitHub-style callout block.

func NewCallout() *Callout

func (n *Callout) Content() []byte

func (n *Callout) Dump(source []byte, level int)

func (n *Callout) Kind() ast.NodeKind

func (n *Callout) SetContent(content []byte)

func (n *Callout) SetTitle(title string)

type Config ¶

type Config struct {
	Writer    html.Writer
	HardWraps bool
	XHTML     bool
	Unsafe    bool
}

A Config struct has configurations for the HTML based renderers.

type Extender ¶

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

Extender allows you to use GitHub-style callouts in markdown

Callouts are blockquotes with special syntax:

> [!NOTE] > This is a note

> [!TIP] > This is a tip

> [!IMPORTANT] > This is important

> [!WARNING] > This is a warning

> [!CAUTION] > This is a caution

func New() *Extender

func (e *Extender) Extend(md goldmark.Markdown)

type Renderer ¶

type Renderer struct {
	Config
}

A Renderer struct is an implementation of renderer.NodeRenderer that renders nodes as (X)HTML.

func (r *Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)