attributes

README

goldmark-inline-attributes

GoldMark inline attributes extension.

This implements the bracketed_spans of pandoc.

[This is *some text*]{.class key="val"} outside text

<p><span class="class" key="val">This is <em>some text</em></span> outside text</p>

var md = goldmark.New(attributes.Enable)
var source = []byte("[Text]{#id .class1}\nother text")
err := md.Convert(source, os.Stdout)
if err != nil {
    log.Fatal(err)
}

Documentation

Index

• Variables
• func NewAttributesParser() parser.InlineParser
• type Extender
  • func (e *Extender) Extend(m goldmark.Markdown)
• type Node
  • func (n *Node) Dump(src []byte, level int)
  • func (*Node) Kind() ast.NodeKind

Variables

var Enable = goldmark.WithExtensions(Extension)

Enable is a goldmark.Option with inline attributes support.

var Extension goldmark.Extender = new(Extender)

Extension is a goldmark.Extender with markdown inline attributes support.

var Kind = ast.NewNodeKind("InlineAttributes")

Kind is the kind of hashtag AST nodes.

Functions

func NewAttributesParser

func NewAttributesParser() parser.InlineParser

NewAttributesParser return a new InlineParser that parses inline attributes like '[txt]{.underline}' .

Types

type Extender

type Extender struct{}

func (*Extender) Extend

func (e *Extender) Extend(m goldmark.Markdown)

type Node

type Node struct {
	ast.BaseInline
}

Node is a parsed attributes node.

func (*Node) Dump

func (n *Node) Dump(src []byte, level int)

func (*Node) Kind

func (*Node) Kind() ast.NodeKind