steps

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 29, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var KindStepItem = gast.NewNodeKind("StepItem")

KindStepItem is the NodeKind for StepItem.

View Source
var KindStepsBlock = gast.NewNodeKind("StepsBlock")

KindStepsBlock is the NodeKind for StepsBlock.

Functions

func NewParser

func NewParser() parser.BlockParser

NewParser returns a new steps block parser.

func NewRenderer

func NewRenderer() renderer.NodeRenderer

NewRenderer returns a new steps renderer.

Types

type Extension

type Extension struct{}

Extension is a goldmark extension that adds steps block support.

func (*Extension) Extend

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

Extend implements goldmark.Extender.

type StepItem

type StepItem struct {
	gast.BaseBlock
	Title        string
	Index        int // 1-based step number
	HeadingLevel int // 2 or 3, matching the source heading
}

StepItem is an AST node representing a single step within a StepsBlock.

func (*StepItem) Dump

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

Dump implements ast.Node.Dump.

func (*StepItem) Kind

func (n *StepItem) Kind() gast.NodeKind

Kind implements ast.Node.Kind.

type StepsBlock

type StepsBlock struct {
	gast.BaseBlock
}

StepsBlock is an AST node representing a steps container.

func (*StepsBlock) Dump

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

Dump implements ast.Node.Dump.

func (*StepsBlock) Kind

func (n *StepsBlock) Kind() gast.NodeKind

Kind implements ast.Node.Kind.

Jump to

Keyboard shortcuts

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