mentions

package

v1.0.0 Latest Latest Go to latest Published: Dec 6, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package mentions is a goldmark extension for user mentions.

This section is empty.

View Source

var Kind = ast.NewNodeKind("Mention")

This section is empty.

type Extender struct {
	Context  context.Context
	Resolver Resolver
}

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

type Node struct {
	ast.BaseInline

	Tag     []byte
	Profile *idmv1.Profile
}

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

func (*Node) Kind() ast.NodeKind

type Parser struct {
	Context context.Context

	Resolver Resolver
}

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

func (*Parser) Trigger() []byte

type Renderer struct {
	Context context.Context
}

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 interface {
	ResolveMention(*Node) (profile *idmv1.Profile, err error)
}

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

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