preprocess

Documentation

Overview

Package preprocess converts a markdown document into a tree of headings for easy querying.

Index

• Variables
• type Tree
  • func GoldmarkToTree(doc ast.Node, source []byte) (Tree, error)
• type TreeBranch
  • func NewTreeBranch(heading *ast.Heading, parent *TreeBranch) *TreeBranch
  • func NewTreeBranchRoot() *TreeBranch
  • func (n *TreeBranch) Dump(source []byte, level int)
  • func (n *TreeBranch) Kind() ast.NodeKind

Variables

var KindTreeBranch = ast.NewNodeKind("TreeBranch")

Types

type Tree

type Tree struct {
	Doc    TreeBranch
	Source []byte
}

A markdown document parsed into a tree of goldmark AST nodes.

func GoldmarkToTree

func GoldmarkToTree(doc ast.Node, source []byte) (Tree, error)

Converts an already parsed goldmark ast into a Heading tree

type TreeBranch

type TreeBranch struct {
	ast.BaseInline
	TreeParent *TreeBranch
	Level      int
}

Represents a branch in the document tree, triggered by a heading. This is also implements goldmark/ast.Node, so it can be used with AST tools.

func NewTreeBranch

func NewTreeBranch(heading *ast.Heading, parent *TreeBranch) *TreeBranch

func NewTreeBranchRoot

func NewTreeBranchRoot() *TreeBranch

A tree branch for the root of the document.

func (*TreeBranch) Dump

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

func (*TreeBranch) Kind

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