mentions

Documentation

Overview

Package mentions is a goldmark extension for user mentions.

Index

• Variables
• type Extender
  • func (e *Extender) Extend(m goldmark.Markdown)
• type Node
  • func (n *Node) Dump(src []byte, level int)
  • func (*Node) Kind() ast.NodeKind
• type Parser
  • func (p *Parser) Parse(_ ast.Node, block text.Reader, _ parser.Context) ast.Node
  • func (*Parser) Trigger() []byte
• type Renderer
  • func (r *Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
  • func (r *Renderer) Render(w util.BufWriter, _ []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
• type Resolver
• type ResolverFunc
  • func (fn ResolverFunc) ResolveMention(n *Node) (*idmv1.Profile, error)

Variables

var Kind = ast.NewNodeKind("Mention")

Types

type Extender

type Extender struct {
	Context  context.Context
	Resolver Resolver
}

func (*Extender) Extend

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

type Node

type Node struct {
	ast.BaseInline

	Tag     []byte
	Profile *idmv1.Profile
}

func (*Node) Dump

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

func (*Node) Kind

func (*Node) Kind() ast.NodeKind

type Parser

type Parser struct {
	Context context.Context

	Resolver Resolver
}

func (*Parser) Parse

func (p *Parser) Parse(_ ast.Node, block text.Reader, _ parser.Context) ast.Node

func (*Parser) Trigger

func (*Parser) Trigger() []byte

type Renderer

type Renderer struct {
	Context context.Context
}

func (*Renderer) RegisterFuncs

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

func (*Renderer) Render

func (r *Renderer) Render(w util.BufWriter, _ []byte, node ast.Node, entering bool) (ast.WalkStatus, error)

type Resolver

type Resolver interface {
	ResolveMention(*Node) (profile *idmv1.Profile, err error)
}

type ResolverFunc

type ResolverFunc func(*Node) (*idmv1.Profile, error)

func (ResolverFunc) ResolveMention

func (fn ResolverFunc) ResolveMention(n *Node) (*idmv1.Profile, error)