extensions

Documentation

Index

• Variables
• type TagExt
  • func (t *TagExt) Extend(m goldmark.Markdown)
• type Tags
  • func (n *Tags) Dump(source []byte, level int)
  • func (n *Tags) Kind() gast.NodeKind
• type WikiLink

Variables

var KindTags = gast.NewNodeKind("Tags")

KindTags is a NodeKind of the Tags node.

var WikiLinkExt = &wikiLink{}

WikiLinkExt is an extension parsing wiki links and Neuron's Folgezettel.

For example, [[wiki link]], [[[legacy downlink]]], #[[uplink]], [[downlink]]#.

Types

type TagExt

type TagExt struct {
	// Indicates whether #hashtags are parsed.
	HashtagEnabled bool
	// Indicates whether Bear's multi-word tags are parsed. Hashtags must be enabled as well.
	MultiWordTagEnabled bool
	// Indicates whether :colon:tags: are parsed.
	ColontagEnabled bool
}

TagExt is an extension parsing various flavors of tags.

* #hashtags, including Bear's #multi words# tags * :colon:separated:tags:`, e.g. vimwiki and Org mode

Are authorized in a tag: * unicode categories [L]etter and [N]umber * / @ ' ~ - _ $ % & + = and when possible # : * any character escaped with \, including whitespace

func (*TagExt) Extend

func (t *TagExt) Extend(m goldmark.Markdown)

type Tags

type Tags struct {
	gast.BaseInline
	// Tags in this list.
	Tags []string
}

Tags represents a list of inline tags in a Markdown document.

func (*Tags) Dump

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

func (*Tags) Kind

func (n *Tags) Kind() gast.NodeKind

type WikiLink

type WikiLink struct {
	ast.Link
}

WikiLink represents a wiki link found in a Markdown document.