Documentation
¶
Overview ¶
Package mdext provides pandoc-flavoured goldmark extensions for the glu Markdown pipeline: fenced divs (::: {.class} … :::), bracketed spans (text{.class}) and a pandoc-style heading identifier generator that keeps non-ASCII letters.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var BracketedSpans goldmark.Extender = &bracketedSpans{}
BracketedSpans is the goldmark extender enabling pandoc bracketed spans.
var FencedDivs goldmark.Extender = &fencedDivs{}
FencedDivs is the goldmark extender enabling pandoc fenced divs.
var KindBracketedSpan = ast.NewNodeKind("BracketedSpan")
KindBracketedSpan is the NodeKind of the BracketedSpan node.
var KindFencedDiv = ast.NewNodeKind("FencedDiv")
KindFencedDiv is the NodeKind of the FencedDiv node.
Functions ¶
func NewPandocIDs ¶
NewPandocIDs returns a parser.IDs implementation with pandoc's auto_identifiers algorithm: keep letters, digits, '_', '-' and '.', lowercase everything, turn spaces into hyphens, strip everything before the first letter, fall back to "section" for letterless headings.
Types ¶
type BracketedSpan ¶
type BracketedSpan struct {
ast.BaseInline
}
A BracketedSpan node represents a pandoc bracketed span: [inline content]{.class key=value}.
func (*BracketedSpan) Dump ¶
func (n *BracketedSpan) Dump(source []byte, level int)
Dump implements ast.Node.Dump.
func (*BracketedSpan) Kind ¶
func (n *BracketedSpan) Kind() ast.NodeKind
Kind implements ast.Node.Kind.
type BracketedSpanHTMLRenderer ¶
type BracketedSpanHTMLRenderer struct{}
BracketedSpanHTMLRenderer renders a BracketedSpan as a span element carrying all authored attributes.
func (*BracketedSpanHTMLRenderer) RegisterFuncs ¶
func (r *BracketedSpanHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements renderer.NodeRenderer.
type FencedDiv ¶
A FencedDiv node represents one pandoc fenced div: a line of at least three colons carrying attributes opens a block container, a line of colons alone closes the innermost open one.
type FencedDivHTMLRenderer ¶
type FencedDivHTMLRenderer struct{}
FencedDivHTMLRenderer renders a FencedDiv as a div element carrying all authored attributes.
func (*FencedDivHTMLRenderer) RegisterFuncs ¶
func (r *FencedDivHTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements renderer.NodeRenderer.
Source Files