extension

README

goldmark-SuperSubscript

This Go module contains two extensions for the Markdown parser Goldmark providing super- and subscripts.

Syntax

Similar to markdown-it the new markup characters are:

• The circumflex ^ for superscript

• The tilde ~ for subscript

We need to place one before and one after the text segment like H~2~O or x^2^.

No whitespace between the two surrounding markup characters is allowed. This way the common slip using TeX syntax like x^2 + x^5 does not lead to messed up HTML. In case we definitely want to insert space we need to place a non-breaking space—either directly or as the HTML entity  .

Documentation

Index

• Variables
• func NewSubscriptHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewSubscriptParser() parser.InlineParser
• func NewSuperscriptHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func NewSuperscriptParser() parser.InlineParser
• type SubscriptHTMLRenderer
  • func (r *SubscriptHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type SuperscriptHTMLRenderer
  • func (r *SuperscriptHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

Variables

var Subscript = &subscript{}

Subscript is an extension that allows you to use a subscript expression like 'x~0~'.

var SubscriptAttributeFilter = html.GlobalAttributeFilter

SubscriptAttributeFilter defines attribute names which dd elements can have.

var Superscript = &superscript{}

Superscript is an extension that allows you to use a superscript expression like 'x^2^'.

var SuperscriptAttributeFilter = html.GlobalAttributeFilter

SuperscriptAttributeFilter defines attribute names which dd elements can have.

Functions

func NewSubscriptHTMLRenderer

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

NewSubscriptHTMLRenderer returns a new SubscriptHTMLRenderer.

func NewSubscriptParser

func NewSubscriptParser() parser.InlineParser

NewSubscriptParser return a new InlineParser that parses subscript expressions.

func NewSuperscriptHTMLRenderer

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

NewSuperscriptHTMLRenderer returns a new SuperscriptHTMLRenderer.

func NewSuperscriptParser

func NewSuperscriptParser() parser.InlineParser

NewSuperscriptParser return a new InlineParser that parses superscript expressions.

Types

type SubscriptHTMLRenderer

type SubscriptHTMLRenderer struct {
	html.Config
}

SubscriptHTMLRenderer is a renderer.NodeRenderer implementation that renders Subscript nodes.

func (*SubscriptHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type SuperscriptHTMLRenderer

type SuperscriptHTMLRenderer struct {
	html.Config
}

SuperscriptHTMLRenderer is a renderer.NodeRenderer implementation that renders Superscript nodes.

func (*SuperscriptHTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.