envvar

package
v0.4.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 21, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var KindEnv = ast.NewNodeKind("Env")

KindEnv is a NodeKind for environment variable nodes.

Functions

func New

func New() goldmark.Extender

New returns a new environment variable extension.

func NewHTMLRenderer

func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewHTMLRenderer returns a new HTMLRenderer.

Types

type Extension

type Extension struct{}

Extension is a goldmark extension for environment variable references.

func (*Extension) Extend

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

Extend implements goldmark.Extender.Extend.

type HTMLRenderer

type HTMLRenderer struct {
	html.Config
}

HTMLRenderer is a renderer for environment variable nodes.

func (*HTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Node

type Node struct {
	ast.BaseInline
	EnvVar []byte
}

Node represents an environment variable reference node in markdown AST.

func (*Node) Dump

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

Dump implements ast.Node.Dump interface.

func (*Node) Inline

func (n *Node) Inline() bool

Inline implements ast.Inline interface.

func (*Node) Kind

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

Kind implements ast.Node.Kind interface.

type Parser

type Parser struct{}

Parser is a Goldmark inline parser for parsing environment variable nodes.

Environment variable references have the format {env}`XDG_DATA_DIRS` which will be rendered as a span with the environment variable name.

func (*Parser) Parse

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

Parse parses an environment variable node.

func (*Parser) Trigger

func (*Parser) Trigger() []byte

Trigger reports characters that trigger this parser.

Directories

Path Synopsis