Documentation
¶
Overview ¶
Package ast defines AST nodes that represents extension's elements
Index ¶
Constants ¶
This section is empty.
Variables ¶
var KindDefinitionDescription = gast.NewNodeKind("DefinitionDescription")
KindDefinitionDescription is a NodeKind of the DefinitionDescription node.
var KindDefinitionList = gast.NewNodeKind("DefinitionList")
KindDefinitionList is a NodeKind of the DefinitionList node.
var KindDefinitionTerm = gast.NewNodeKind("DefinitionTerm")
KindDefinitionTerm is a NodeKind of the DefinitionTerm node.
var KindFootnote = gast.NewNodeKind("Footnote")
KindFootnote is a NodeKind of the Footnote node.
var KindFootnoteBackLink = gast.NewNodeKind("FootnoteBackLink")
KindFootnoteBackLink is a NodeKind of the FootnoteBackLink 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.
var KindStrikethrough = gast.NewNodeKind("Strikethrough")
KindStrikethrough is a NodeKind of the Strikethrough node.
var KindTable = gast.NewNodeKind("Table")
KindTable is a NodeKind of the Table node.
var KindTableCell = gast.NewNodeKind("TableCell")
KindTableCell is a NodeKind of the TableCell node.
var KindTableHeader = gast.NewNodeKind("TableHeader")
KindTableHeader is a NodeKind of the TableHeader node.
var KindTableRow = gast.NewNodeKind("TableRow")
KindTableRow is a NodeKind of the TableRow node.
var KindTaskCheckBox = gast.NewNodeKind("TaskCheckBox")
KindTaskCheckBox is a NodeKind of the TaskCheckBox node.
Functions ¶
This section is empty.
Types ¶
type DefinitionDescription ¶
A DefinitionDescription struct represents a definition list description of Markdown (PHPMarkdownExtra) text.
func NewDefinitionDescription ¶
func NewDefinitionDescription() *DefinitionDescription
NewDefinitionDescription returns a new DefinitionDescription node.
func (*DefinitionDescription) Dump ¶
func (n *DefinitionDescription) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*DefinitionDescription) Kind ¶
func (n *DefinitionDescription) Kind() gast.NodeKind
Kind implements Node.Kind.
type DefinitionList ¶
A DefinitionList struct represents a definition list of Markdown (PHPMarkdownExtra) text.
func NewDefinitionList ¶
func NewDefinitionList(offset int, para *gast.Paragraph) *DefinitionList
NewDefinitionList returns a new DefinitionList node.
func (*DefinitionList) Dump ¶
func (n *DefinitionList) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*DefinitionList) Kind ¶
func (n *DefinitionList) Kind() gast.NodeKind
Kind implements Node.Kind.
type DefinitionTerm ¶
A DefinitionTerm struct represents a definition list term of Markdown (PHPMarkdownExtra) text.
func NewDefinitionTerm ¶
func NewDefinitionTerm() *DefinitionTerm
NewDefinitionTerm returns a new DefinitionTerm node.
func (*DefinitionTerm) Dump ¶
func (n *DefinitionTerm) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*DefinitionTerm) Kind ¶
func (n *DefinitionTerm) Kind() gast.NodeKind
Kind implements Node.Kind.
type Footnote ¶
A Footnote struct represents a footnote of Markdown (PHP Markdown Extra) text.
type FootnoteBackLink ¶
type FootnoteBackLink struct {
gast.BaseInline
Index int
}
A FootnoteBackLink struct represents a link to a footnote of Markdown (PHP Markdown Extra) text.
func NewFootnoteBackLink ¶
func NewFootnoteBackLink(index int) *FootnoteBackLink
NewFootnoteBackLink returns a new FootnoteBackLink node.
func (*FootnoteBackLink) Dump ¶
func (n *FootnoteBackLink) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*FootnoteBackLink) Kind ¶
func (n *FootnoteBackLink) 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.
type FootnoteList ¶
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.
type Strikethrough ¶
type Strikethrough struct {
gast.BaseInline
}
A Strikethrough struct represents a strikethrough of GFM text.
func NewStrikethrough ¶
func NewStrikethrough() *Strikethrough
NewStrikethrough returns a new Strikethrough node.
func (*Strikethrough) Dump ¶
func (n *Strikethrough) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*Strikethrough) Kind ¶
func (n *Strikethrough) Kind() gast.NodeKind
Kind implements Node.Kind.
type Table ¶
type Table struct {
gast.BaseBlock
// Alignments returns alignments of the columns.
Alignments []Alignment
}
A Table struct represents a table of Markdown(GFM) text.
type TableCell ¶
A TableCell struct represents a table cell of a Markdown(GFM) text.
type TableHeader ¶
A TableHeader struct represents a table header of Markdown(GFM) text.
func NewTableHeader ¶
func NewTableHeader(row *TableRow) *TableHeader
NewTableHeader returns a new TableHeader node.
func (*TableHeader) Dump ¶
func (n *TableHeader) Dump(source []byte, level int)
Dump implements Node.Dump.
type TableRow ¶
A TableRow struct represents a table row of Markdown(GFM) text.
func NewTableRow ¶
NewTableRow returns a new TableRow node.
type TaskCheckBox ¶
type TaskCheckBox struct {
gast.BaseInline
IsChecked bool
}
A TaskCheckBox struct represents a checkbox of a task list.
func NewTaskCheckBox ¶
func NewTaskCheckBox(checked bool) *TaskCheckBox
NewTaskCheckBox returns a new TaskCheckBox node.
func (*TaskCheckBox) Dump ¶
func (n *TaskCheckBox) Dump(source []byte, level int)
Dump implements Node.Dump.
Source Files