node

Documentation

Overview

Package node holds the syntax tree nodes for a parse minidown document.

Index

• type Block
• type Emphasis
• type Heading
• type Link
• type NewLine
• type Node
• type Tag
• type Text
• type Whitespace

Types

type Block

type Block struct {
	Children []Node
}

Block represents a collection of nodes in sequential order.

type Emphasis

type Emphasis struct {
	Style string // "**", "_" etc
	Body  Node
}

Emphasis represents a emphasis node.

type Heading

type Heading struct {
	Scale int // {1: H1, 2: H2} and so on.
	Body  Node
}

Heading represents a heading node.

type Link

type Link struct {
	Body   Node
	Target Node
}

Link represents a link in the form: [body](target).

type NewLine

type NewLine struct{}

NewLine represents a blank new line.

type Node

type Node interface{}

Node represents a node in a minidown document graph.

type Tag

type Tag struct {
	Identifier string
	Type       string
}

Tag represents a tag in the form: {{identifier:type}}, where "type" is optional and is "string" by default.

type Text

type Text struct {
	Text string
}

Text represent a block of text.

type Whitespace

type Whitespace struct{}

Whitespace represent a whitespace.