extensions

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Aug 23, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var KindTaskCheckBox = ast.NewNodeKind("TaskCheckBox")

KindTaskCheckBox is a NodeKind of the TaskCheckBox node

View Source
var WikilinkKind = ast.NewNodeKind("Wikilink")

WikilinkKind is the kind for wikilink nodes

Functions

func NewTaskListExtension

func NewTaskListExtension(cfg *config.Config) goldmark.Extender

NewTaskListExtension creates a new task list extension with configuration

func NewTaskListParser

func NewTaskListParser(cfg *config.Config) parser.InlineParser

NewTaskListParser creates a new task list parser with configuration

func NewWikilinkExtension

func NewWikilinkExtension() goldmark.Extender

NewWikilinkExtension creates a new wikilink extension

Types

type TaskCheckBox

type TaskCheckBox struct {
	ast.BaseInline
	State string // The actual state value (e.g., " ", "x", "wip", "in-progress")
}

TaskCheckBox represents a task list checkbox node with configurable states

func NewTaskCheckBox

func NewTaskCheckBox(state string) *TaskCheckBox

NewTaskCheckBox creates a new TaskCheckBox node with a state string

func (*TaskCheckBox) Dump

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

Dump implements ast.Node.Dump

func (*TaskCheckBox) Kind

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

Kind implements ast.Node.Kind

type TaskListExtension

type TaskListExtension struct {
	// contains filtered or unexported fields
}

TaskListExtension is an extension that adds support for configurable task lists

func (*TaskListExtension) Extend

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

Extend implements goldmark.Extender.Extend

type WikilinkAST

type WikilinkAST struct {
	ast.BaseInline
	Target      string
	DisplayText string
}

WikilinkAST represents a wikilink in the goldmark AST

func (*WikilinkAST) Dump

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

Dump implements ast.Node

func (*WikilinkAST) Kind

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

Kind returns the node kind

type WikilinkExtension

type WikilinkExtension struct{}

WikilinkExtension adds support for wikilinks ([[page]] and [[page|display]])

func (*WikilinkExtension) Extend

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

Extend implements goldmark.Extender

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL