custom

Documentation

Index

• Variables
• func NewPanelParser() parser.BlockParser
• func NewSpanParser() parser.InlineParser
• func NewTableParser() parser.BlockParser
• type Panel
  • func NewPanel(panelType string) *Panel
  • func (n *Panel) Dump(source []byte, level int)
  • func (n *Panel) Kind() ast.NodeKind
• type Span
  • func NewSpan(value string) *Span
  • func (n *Span) Dump(source []byte, level int)
  • func (n *Span) Kind() ast.NodeKind
• type Table
  • func NewTable() *Table
  • func (n *Table) Dump(source []byte, level int)
  • func (n *Table) Kind() ast.NodeKind
• type TableType

Variables

var KindPanel = ast.NewNodeKind("Panel")

KindPanel is a NodeKind of the Panel node.

var KindSpan = ast.NewNodeKind("Span")

KindSpan is a NodeKind of the Span node.

var KindTable = ast.NewNodeKind("Table")

KindTable is a NodeKind of the Table node.

Functions

func NewPanelParser

func NewPanelParser() parser.BlockParser

NewPanelParser returns a new BlockParser that parses panels.

func NewSpanParser

func NewSpanParser() parser.InlineParser

NewSpanParser returns a new InlineParser that can parse spans with attributes, like [foo bar]{.myClass}. See https://talk.commonmark.org/t/consistent-attribute-syntax/272. This parser must take precedence over the parser.LinkParser.

func NewTableParser

func NewTableParser() parser.BlockParser

NewTableParser returns a new BlockParser that parses tables. This parser must take precedence over the parser.ThematicBreakParser.

Types

type Panel

type Panel struct {
	ast.BaseBlock
	PanelType string
}

A Panel struct represents a panel in atlaskit.

func NewPanel

func NewPanel(panelType string) *Panel

NewPanel returns a new Panel node.

func (*Panel) Dump

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

Dump implements Node.Dump.

func (*Panel) Kind

func (n *Panel) Kind() ast.NodeKind

Kind implements Node.Kind.

type Span

type Span struct {
	ast.BaseInline
	Value string
}

A Span struct represents a span of text with attributes.

func NewSpan

func NewSpan(value string) *Span

NewSpan returns a new Span node.

func (*Span) Dump

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

Dump implements Node.Dump.

func (*Span) Kind

func (n *Span) Kind() ast.NodeKind

Kind implements Node.Kind.

type Table

type Table struct {
	ast.BaseBlock
}

A Table struct represents a table in atlaskit.

func NewTable

func NewTable() *Table

NewTable returns a new Table node.

func (*Table) Dump

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

Dump implements Node.Dump.

func (*Table) Kind

func (n *Table) Kind() ast.NodeKind

Kind implements Node.Kind.

type TableType

type TableType int