blocktags

Documentation

Index

• Variables
• func NewBlockTagExtender(view types.HTMLView, link types.Link) goldmark.Extender
• func NewBlockTagParser(allowed []*TagDef) *blockTagParser
• func NewBlockTagRenderer(view types.HTMLView, link types.Link, opts ...html.Option) renderer.NodeRenderer
• func NewGalleryTransformer() *galleryTransformer
• type BlockTag
  • func NewBlockTag(name string, title string) *BlockTag
  • func (n *BlockTag) Dump(source []byte, level int)
  • func (n *BlockTag) Kind() ast.NodeKind
• type BlockTagRenderer
  • func (r *BlockTagRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type DefMap
  • func (dm DefMap) GetTag(name string) *TagDef
• type TagDef

Variables

var ClosingBlockTagRe = regexp.MustCompile(`^{/([a-z]+)}`)

var DefaultTags = []*TagDef{
	{
		Name:              "cut",
		AllowedParentTags: nil,
	},
	{
		Name:              "spoiler",
		AllowedParentTags: []string{"cut"},
	},
	{
		Name:              "gallery",
		AllowedParentTags: []string{"spoiler", "cut"},
	},
}

var KindBlockTag = ast.NewNodeKind("BlockTag")

var OpeningBlockTagRe = regexp.MustCompile(`^{([a-z]+)(\s+([^}]+))?}`)

Functions

func NewBlockTagExtender

func NewBlockTagExtender(view types.HTMLView, link types.Link) goldmark.Extender

NewBlockTag creates a new goldmark.Extender that allow you to parse text that seems like a @userblockTag

func NewBlockTagParser

func NewBlockTagParser(allowed []*TagDef) *blockTagParser

func NewBlockTagRenderer

func NewBlockTagRenderer(view types.HTMLView, link types.Link, opts ...html.Option) renderer.NodeRenderer

func NewGalleryTransformer

func NewGalleryTransformer() *galleryTransformer

Types

type BlockTag

type BlockTag struct {
	ast.BaseBlock
	BlockTagName string
	BlockTitle   string
}

func NewBlockTag

func NewBlockTag(name string, title string) *BlockTag

func (*BlockTag) Dump

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

func (*BlockTag) Kind

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

type BlockTagRenderer

type BlockTagRenderer struct {
	html.Config
	// contains filtered or unexported fields
}

func (*BlockTagRenderer) RegisterFuncs

func (r *BlockTagRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type DefMap

type DefMap map[string]*TagDef

func (DefMap) GetTag

func (dm DefMap) GetTag(name string) *TagDef

type TagDef

type TagDef struct {
	Name              string
	AllowedParentTags []string
}