subscript

README

goldmark-subscript

GoldMark subscript extension.

This implements the subscript of pandoc.

H~2~O is a liquid.  2^10^ is 1024.

<p>H<sub>2</sub>O is a liquid.  2^10^ is 1024.</p>

var md = goldmark.New(subscript.Enable)
var source = []byte("H~2~O is a liquid.  2^10^ is 1024.")
err := md.Convert(source, os.Stdout)
if err != nil {
    log.Fatal(err)
}

Documentation

Index

• Variables
• type Extender
  • func (e *Extender) Extend(m goldmark.Markdown)
• type Node
  • func (n *Node) Dump(src []byte, level int)
  • func (*Node) Kind() ast.NodeKind

Variables

var Enable = goldmark.WithExtensions(Extension)

Enable is a goldmark.Option with inline attributes support.

var Extension goldmark.Extender = new(Extender)

Extension is a goldmark.Extender with markdown inline attributes support.

var Kind = ast.NewNodeKind("Subscript")

Kind is the kind of hashtag AST nodes.

Types

type Extender

type Extender struct{}

func (*Extender) Extend

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

type Node

type Node struct {
	ast.BaseInline
}

Node is a parsed Subscript node.

func (*Node) Dump

func (n *Node) Dump(src []byte, level int)

func (*Node) Kind

func (*Node) Kind() ast.NodeKind