extensions

Documentation

Index

• Variables
• func NewAtHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewAtParser() parser.InlineParser
• func NewDateHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewDateParser() parser.InlineParser
• func NewLatexHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewLatexParser() parser.InlineParser
• func NewPostHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewPostParser() parser.InlineParser
• func NewReferHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewReferParser() parser.InlineParser
• func NewTaskCheckBoxHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewTaskCheckBoxParser() parser.InlineParser
• type AtHTMLRenderer
  • func (r *AtHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type DateHTMLRenderer
  • func (r *DateHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type LatexHTMLRenderer
  • func (r *LatexHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type LocalLatexJSON
• type PostHTMLRenderer
  • func (r *PostHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type ReferHTMLRenderer
  • func (r *ReferHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type TaskCheckBoxHTMLRenderer
  • func (r *TaskCheckBoxHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

Variables

var At = &at{}

At is an extension that allow you to use at expression like '@john' .

var Date = &date{}

Date is an extension that allow you to use date expression like '$x^2$' .

var Latex = &latex{}

Latex is an extension that allow you to use latex expression like '$x^2$' .

var Post = &post{}

Post is an extension that allow you to use post expression like '$x^2$' .

var Refer = &refer{}

Refer is an extension that allow you to use refer expression like '$x^2$' .

var TaskList = &taskList{}

TaskList is an extension that allow you to use GFM task lists.

Functions

func NewAtHTMLRenderer

func NewAtHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewAtHTMLRenderer returns a new AtHTMLRenderer.

func NewAtParser

func NewAtParser() parser.InlineParser

NewAtParser return a new InlineParser that parses at expressions.

func NewDateHTMLRenderer

func NewDateHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewDateHTMLRenderer returns a new DateHTMLRenderer.

func NewDateParser

func NewDateParser() parser.InlineParser

NewDateParser return a new InlineParser that parses date expressions.

func NewLatexHTMLRenderer

func NewLatexHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewLatexHTMLRenderer returns a new LatexHTMLRenderer.

func NewLatexParser

func NewLatexParser() parser.InlineParser

NewLatexParser return a new InlineParser that parses latex expressions.

func NewPostHTMLRenderer

func NewPostHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewPostHTMLRenderer returns a new PostHTMLRenderer.

func NewPostParser

func NewPostParser() parser.InlineParser

NewPostParser return a new InlineParser that parses post expressions.

func NewReferHTMLRenderer

func NewReferHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewReferHTMLRenderer returns a new ReferHTMLRenderer.

func NewReferParser

func NewReferParser() parser.InlineParser

NewReferParser return a new InlineParser that parses refer expressions.

func NewTaskCheckBoxHTMLRenderer

func NewTaskCheckBoxHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewTaskCheckBoxHTMLRenderer returns a new TaskCheckBoxHTMLRenderer.

func NewTaskCheckBoxParser

func NewTaskCheckBoxParser() parser.InlineParser

NewTaskCheckBoxParser returns a new InlineParser that can parse checkboxes in list items. This parser must take precedence over the parser.LinkParser.

Types

type AtHTMLRenderer

type AtHTMLRenderer struct {
	html.Config
}

AtHTMLRenderer is a renderer.NodeRenderer implementation that renders At nodes.

func (*AtHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type DateHTMLRenderer

type DateHTMLRenderer struct {
	html.Config
}

DateHTMLRenderer is a renderer.NodeRenderer implementation that renders Date nodes.

func (*DateHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type LatexHTMLRenderer

type LatexHTMLRenderer struct {
	html.Config
}

LatexHTMLRenderer is a renderer.NodeRenderer implementation that renders Latex nodes.

func (*LatexHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type LocalLatexJSON

type LocalLatexJSON struct {
	SpeakText string `json:"speakText"`
	SVG       string `json:"svg"`
	Width     string `json:"width"`
	Height    string `json:"height"`
	Style     string `json:"style"`
}

LocalLatexJSON is the response from local Latex server

type PostHTMLRenderer

type PostHTMLRenderer struct {
	html.Config
}

PostHTMLRenderer is a renderer.NodeRenderer implementation that renders Post nodes.

func (*PostHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type ReferHTMLRenderer

type ReferHTMLRenderer struct {
	html.Config
}

ReferHTMLRenderer is a renderer.NodeRenderer implementation that renders Refer nodes.

func (*ReferHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type TaskCheckBoxHTMLRenderer

type TaskCheckBoxHTMLRenderer struct {
	html.Config
}

TaskCheckBoxHTMLRenderer is a renderer.NodeRenderer implementation that renders checkboxes in list items.

func (*TaskCheckBoxHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.