markdown

package
v0.0.0 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2025 License: UNKNOWN not legal advice Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source
const MaxDepth = 6

Variables

View Source
var (
	ErrColumnsInvalidOpenFormat      = errors.New("invalid heading format")
	ErrColumnsUnexpectedOrInvalidTag = errors.New("unexpected or invalid tag")
)

Error messages for invalid column tags.

View Source
var (
	KindColumn = ast.NewNodeKind("Column")
	MaxHeading = 6
)

Define custom node kind and maximum heading level.

View Source
var Columns = &columns{}

Columns instance for extending markdown with column functionality.

View Source
var GnoExtension = &gnoExtension{}

Functions

This section is empty.

Types

type ColumnNode

type ColumnNode struct {
	ast.BaseBlock
	Index int       // Index of the column associated with the node.
	Tag   ColumnTag // Current Column Tag for this node.
	Error error     // If not nil, indicates that the node is invalid.
	// contains filtered or unexported fields
}

ColumnNode represents a semantic tree for a "column".

func NewColumn

func NewColumn(ctx *columnsContext, index int, tag ColumnTag) *ColumnNode

NewColumn initializes a ColumnNode object.

func (*ColumnNode) Dump

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

Dump implements Node.Dump for debug representation.

func (*ColumnNode) Kind

func (*ColumnNode) Kind() ast.NodeKind

Kind implements Node.Kind.

func (*ColumnNode) String

func (n *ColumnNode) String() string

type ColumnTag

type ColumnTag int

ColumnTag represents the type of tag in a column block.

const (
	ColumnTagUndefined ColumnTag = iota
	ColumnTagOpen
	ColumnTagSep
	ColumnTagClose
)

type GenFunc

type GenFunc func(t *testing.T, nameIn string, input []byte) (nameOut string, output []byte)

type GoldenTests

type GoldenTests struct {
	Recurse      bool
	Update       bool
	GenerateFunc GenFunc
}

func NewGoldentTests

func NewGoldentTests(exec GenFunc) *GoldenTests

func (*GoldenTests) Run

func (g *GoldenTests) Run(t *testing.T, dir string)

type Toc

type Toc struct {
	Items []*TocItem
}

func TocInspect

func TocInspect(n ast.Node, src []byte, opts TocOptions) (Toc, error)

type TocItem

type TocItem struct {
	// Title of this item in the table of contents.
	//
	// This may be blank for items that don't refer to a heading, and only
	// have sub-items.
	Title []byte

	// ID is the identifier for the heading that this item refers to. This
	// is the fragment portion of the link without the "#".
	//
	// This may be blank if the item doesn't have an id assigned to it, or
	// if it doesn't have a title.
	//
	// Enable AutoHeadingID in your parser if you expected these to be set
	// but they weren't.
	ID []byte

	// Items references children of this item.
	//
	// For a heading at level 3, Items, contains the headings at level 4
	// under that section.
	Items []*TocItem
}

func (TocItem) Anchor

func (i TocItem) Anchor() string

type TocOptions

type TocOptions struct {
	MinDepth, MaxDepth int
}

Jump to

Keyboard shortcuts

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