ast

Documentation

Index

• Variables
• type Footnote
  • func NewFootnote(ref []byte) *Footnote
  • func (n *Footnote) Dump(source []byte, level int)
  • func (n *Footnote) Kind() gast.NodeKind
• type FootnoteLink
  • func NewFootnoteLink(index int) *FootnoteLink
  • func (n *FootnoteLink) Dump(source []byte, level int)
  • func (n *FootnoteLink) Kind() gast.NodeKind
• type FootnoteList
  • func NewFootnoteList() *FootnoteList
  • func (n *FootnoteList) Dump(source []byte, level int)
  • func (n *FootnoteList) Kind() gast.NodeKind

Variables

var KindFootnote = gast.NewNodeKind("Footnote")

KindFootnote is a NodeKind of the Footnote node.

var KindFootnoteLink = gast.NewNodeKind("FootnoteLink")

KindFootnoteLink is a NodeKind of the FootnoteLink node.

var KindFootnoteList = gast.NewNodeKind("FootnoteList")

KindFootnoteList is a NodeKind of the FootnoteList node.

Types

type Footnote

type Footnote struct {
	gast.BaseBlock
	Ref   []byte
	Index int
}

A Footnote struct represents a footnote of Markdown (PHP Markdown Extra) text.

func NewFootnote

func NewFootnote(ref []byte) *Footnote

NewFootnote returns a new Footnote node.

func (*Footnote) Dump

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

Dump implements Node.Dump.

func (*Footnote) Kind

func (n *Footnote) Kind() gast.NodeKind

Kind implements Node.Kind.

type FootnoteLink

type FootnoteLink struct {
	gast.BaseInline
	Index int
}

A FootnoteLink struct represents a link to a footnote of Markdown (PHP Markdown Extra) text.

func NewFootnoteLink

func NewFootnoteLink(index int) *FootnoteLink

NewFootnoteLink returns a new FootnoteLink node.

func (*FootnoteLink) Dump

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

Dump implements Node.Dump.

func (*FootnoteLink) Kind

func (n *FootnoteLink) Kind() gast.NodeKind

Kind implements Node.Kind.

type FootnoteList

type FootnoteList struct {
	gast.BaseBlock
	Count int
}

A FootnoteList struct represents footnotes of Markdown (PHP Markdown Extra) text.

func NewFootnoteList

func NewFootnoteList() *FootnoteList

NewFootnoteList returns a new FootnoteList node.

func (*FootnoteList) Dump

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

Dump implements Node.Dump.

func (*FootnoteList) Kind

func (n *FootnoteList) Kind() gast.NodeKind

Kind implements Node.Kind.