extension

Documentation

Index

• Variables
• func NewEmphasisHTMLRenderer(opts ...Option) renderer.NodeRenderer
• func NewEmphasisParser() parser.InlineParser
• func NewSpoilerHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewSpoilerParser() parser.InlineParser
• func NewStrikethroughHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewStrikethroughParser() parser.InlineParser
• func NewTemplateHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewTemplateParser() parser.InlineParser
• func WithLevel(level int) interface{ ... }
• type Config
  • func NewConfig() Config
• type EmphasisHTMLRenderer
  • func (r *EmphasisHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type Option
• type SpoilerHTMLRenderer
  • func (r *SpoilerHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type StrikethroughHTMLRenderer
  • func (r *StrikethroughHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type TemplateHTMLRenderer
  • func (r *TemplateHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

Variables

var (
	// Emphasis is an extension that allow you to use emphasis expressions like '*bold*', '_italic_'.
	Emphasis = &emphasis{WithLevel(1)}
	// EmphasisV2 is an extension that allow you to use emphasis expressions like '*bold*', '_italic_' or '__undeline__'.
	EmphasisV2 = &emphasis{WithLevel(2)}
)

var Spoiler = &spoiler{}

Spoiler is an extension that allow you to use spoiler expression like '||spoiler||'.

var Strikethrough = &strikethrough{}

Strikethrough is an extension that allow you to use strikethrough expression like '~strikethrough~'.

var TGM = &tgm{}

TGM is an extension that provides Telegram markdown functionalities.

var TGMV2 = &tgmV2{}

TGMV2 is an extension that provides Telegram markdownV2 functionalities.

var Template = &template{}

Template is an extension that allow you to use template expression like '{{.Count}}'.

Functions

func NewEmphasisHTMLRenderer

func NewEmphasisHTMLRenderer(opts ...Option) renderer.NodeRenderer

NewEmphasisHTMLRenderer returns a new EmphasisHTMLRenderer.

func NewEmphasisParser

func NewEmphasisParser() parser.InlineParser

NewEmphasisParser return a new InlineParser that parses emphasis expressions.

func NewSpoilerHTMLRenderer

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

NewSpoilerHTMLRenderer returns a new SpoilerHTMLRenderer.

func NewSpoilerParser

func NewSpoilerParser() parser.InlineParser

NewSpoilerParser return a new InlineParser that parses spoiler expressions.

func NewStrikethroughHTMLRenderer

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

NewStrikethroughHTMLRenderer returns a new StrikethroughHTMLRenderer.

func NewStrikethroughParser

func NewStrikethroughParser() parser.InlineParser

NewStrikethroughParser return a new InlineParser that parses strikethrough expressions.

func NewTemplateHTMLRenderer

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

NewTemplateHTMLRenderer returns a new TemplateHTMLRenderer.

func NewTemplateParser

func NewTemplateParser() parser.InlineParser

NewTemplateParser return a new InlineParser that parses template expressions.

func WithLevel

func WithLevel(level int) interface {
	Option
}

Types

type Config

type Config struct {
	Writer html.Writer
	Level  int
}

func NewConfig

func NewConfig() Config

type EmphasisHTMLRenderer

type EmphasisHTMLRenderer struct {
	Config
}

EmphasisHTMLRenderer is a renderer.NodeRenderer implementation that renders Emphasis nodes.

func (*EmphasisHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Option

type Option interface {
	SetHTMLOption(*Config)
}

type SpoilerHTMLRenderer

type SpoilerHTMLRenderer struct {
	html.Config
}

SpoilerHTMLRenderer is a renderer.NodeRenderer implementation that renders Spoiler nodes.

func (*SpoilerHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type StrikethroughHTMLRenderer

type StrikethroughHTMLRenderer struct {
	html.Config
}

StrikethroughHTMLRenderer is a renderer.NodeRenderer implementation that renders Strikethrough nodes.

func (*StrikethroughHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type TemplateHTMLRenderer

type TemplateHTMLRenderer struct {
	html.Config
}

TemplateHTMLRenderer is a renderer.NodeRenderer implementation that renders Template nodes.

func (*TemplateHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.