Documentation
¶
Index ¶
- Variables
- func NewEmojiParser() parser.InlineParser
- func NewEmojiRenderer() renderer.NodeRenderer
- func NewRundownASTTransformer() parser.ASTTransformer
- func NewRundownBlockParser() parser.BlockParser
- func NewRundownInlineParser() parser.InlineParser
- func NewRundownParaTransformer() parser.ParagraphTransformer
- func NewTextSubParser() parser.InlineParser
- type Container
- type EmojiInline
- type EmojiRenderer
- type ExecutionBlock
- type Flag
- type Modifiers
- type Parameter
- type RundownBlock
- type RundownInline
- type RundownInlineParser
- type RundownNode
- type Section
- type SectionedDocument
- type TextSubInline
Constants ¶
This section is empty.
Variables ¶
var Emoji = &emojiExt{}
Emoji is an extension that allow you to use emoji expression like '~~text~~' .
var EmojiAttributeFilter = html.GlobalAttributeFilter
EmojiAttributeFilter defines attribute names which dd elements can have.
var KindContainer = ast.NewNodeKind("Container")
var KindEmojiInline = gast.NewNodeKind("Emoji")
KindEmojiInline is a NodeKind of the Emoji node.
var KindExecutionBlock = ast.NewNodeKind("ExecutionBlock")
KindRundownBlock is a NodeKind of the RundownBlock node.
var KindRundownBlock = ast.NewNodeKind("RundownBlock")
KindRundownBlock is a NodeKind of the RundownBlock node.
var KindRundownInline = ast.NewNodeKind("RundownInline")
KindRundown is a NodeKind of the Rundown node.
var KindSection = ast.NewNodeKind("Section")
KindRundownBlock is a NodeKind of the RundownBlock node.
var KindSectionedDocument = ast.NewNodeKind("SectionedDocument")
KindRundownBlock is a NodeKind of the RundownBlock node.
var KindTextSubInline = ast.NewNodeKind("TextSubInline")
KindRundownBlock is a NodeKind of the RundownBlock node.
var RundownElements = &rundownElements{}
Functions ¶
func NewEmojiParser ¶
func NewEmojiParser() parser.InlineParser
NewEmojiParser return a new InlineParser that parses emoji expressions.
func NewEmojiRenderer ¶
func NewEmojiRenderer() renderer.NodeRenderer
NewEmojiHTMLRenderer returns a new EmojiHTMLRenderer.
func NewRundownASTTransformer ¶
func NewRundownASTTransformer() parser.ASTTransformer
NewFootnoteASTTransformer returns a new parser.ASTTransformer that insert a footnote list to the last of the document.
func NewRundownBlockParser ¶
func NewRundownBlockParser() parser.BlockParser
func NewRundownInlineParser ¶
func NewRundownInlineParser() parser.InlineParser
NewRundownInlineParser return a new InlineParser that can parse inline htmls
func NewRundownParaTransformer ¶
func NewRundownParaTransformer() parser.ParagraphTransformer
func NewTextSubParser ¶
func NewTextSubParser() parser.InlineParser
NewEmphasisParser return a new InlineParser that parses emphasises.
Types ¶
type Container ¶
func NewContainer ¶
type EmojiInline ¶
type EmojiInline struct {
gast.BaseInline
EmojiCode string
}
A EmojiInline struct represents a emoji of GFM text.
func NewEmojiInline ¶
func NewEmojiInline(code string) *EmojiInline
NewEmojiInline returns a new EmojiInline node.
func (*EmojiInline) Dump ¶
func (n *EmojiInline) Dump(source []byte, level int)
Dump implements Node.Dump.
type EmojiRenderer ¶
EmojiHTMLRenderer is a renderer.NodeRenderer implementation that renders Emoji nodes.
func (*EmojiRenderer) RegisterFuncs ¶
func (r *EmojiRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.
type ExecutionBlock ¶
type ExecutionBlock struct {
ast.BaseBlock
Modifiers *Modifiers
Syntax string
Origin *ast.FencedCodeBlock
ID string
}
func NewExecutionBlock ¶
func NewExecutionBlock(syntax string, modifiers *Modifiers) *ExecutionBlock
NewRundownBlock returns a new RundownBlock node.
func (*ExecutionBlock) Dump ¶
func (n *ExecutionBlock) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*ExecutionBlock) Kind ¶
func (n *ExecutionBlock) Kind() ast.NodeKind
Kind implements Node.Kind.
func (*ExecutionBlock) SetOrigin ¶
func (n *ExecutionBlock) SetOrigin(fcb *ast.FencedCodeBlock, source []byte)
IsRaw implements Node.IsRaw.
type Modifiers ¶
func MergeModifiers ¶
func NewModifiers ¶
func NewModifiers() *Modifiers
func ParseModifiers ¶
type RundownBlock ¶
func NewRundownBlock ¶
func NewRundownBlock(modifiers *Modifiers) *RundownBlock
NewRundownBlock returns a new RundownBlock node.
func (*RundownBlock) Dump ¶
func (n *RundownBlock) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*RundownBlock) GetModifiers ¶
func (n *RundownBlock) GetModifiers() *Modifiers
type RundownInline ¶
type RundownInline struct {
ast.BaseInline
Segments *text.Segments
Modifiers *Modifiers
MutateContents func(input []byte) []byte
}
A Rundown struct represents an inline <rundown> element.
func NewRundownInline ¶
func NewRundownInline(mods *Modifiers) *RundownInline
NewRundown returns a new Rundown node.
func (*RundownInline) Dump ¶
func (n *RundownInline) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*RundownInline) GetModifiers ¶
func (n *RundownInline) GetModifiers() *Modifiers
type RundownInlineParser ¶
type RundownInlineParser struct {
}
func (*RundownInlineParser) CloseBlock ¶
func (s *RundownInlineParser) CloseBlock(parent ast.Node, pc parser.Context)
func (*RundownInlineParser) Trigger ¶
func (s *RundownInlineParser) Trigger() []byte
type RundownNode ¶
type Section ¶
type Section struct {
ast.BaseBlock
Handlers *Container
Options *Container
Description list.List // Description is a list as we want to keep it inside the DOM.
Setups list.List // Setups is a list to keep them in the DOM too.
Label *string
FunctionName *string
Level int
Name string
// contains filtered or unexported fields
}
func NewSectionForRoot ¶
func NewSectionForRoot() *Section
func NewSectionFromHeading ¶
NewRundownBlock returns a new RundownBlock node.
func (*Section) AppendChild ¶
func (*Section) ForceLevel ¶
Shifts to Root Level, and then adds the given Level to all.
func (*Section) ForceRootLevel ¶
func (n *Section) ForceRootLevel()
Forces the section to be at Level 1, and all children are shifted accordingly.
type SectionedDocument ¶
func NewSectionedDocument ¶
func NewSectionedDocument() *SectionedDocument
NewRundownBlock returns a new RundownBlock node.
func (*SectionedDocument) AddSection ¶
func (n *SectionedDocument) AddSection(section *Section)
func (*SectionedDocument) Dump ¶
func (n *SectionedDocument) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*SectionedDocument) Kind ¶
func (n *SectionedDocument) Kind() ast.NodeKind
Kind implements Node.Kind.
type TextSubInline ¶
type TextSubInline struct {
ast.BaseInline
Segment text.Segment
// contains filtered or unexported fields
}
func NewTextSubInline ¶
func NewTextSubInline() *TextSubInline
NewRundownBlock returns a new RundownBlock node.
func (*TextSubInline) Dump ¶
func (n *TextSubInline) Dump(source []byte, level int)
Dump implements Node.Dump.
func (*TextSubInline) Substitute ¶
func (n *TextSubInline) Substitute(contents []byte)
func (*TextSubInline) Text ¶
func (n *TextSubInline) Text(source []byte) []byte
Source Files