document

Documentation

Index

• type Block
• type BlockKind
• type Blocks
• type CodeBlock
  • func (b *CodeBlock) Attributes() map[string]string
  • func (b *CodeBlock) Content() []byte
  • func (b *CodeBlock) Intro() string
  • func (CodeBlock) Kind() BlockKind
  • func (b *CodeBlock) Language() string
  • func (b *CodeBlock) Lines() []string
  • func (b *CodeBlock) Name() string
  • func (b *CodeBlock) Unwrap() ast.Node
  • func (b *CodeBlock) Value() []byte
• type CodeBlocks
  • func CollectCodeBlocks(node *Node) (result CodeBlocks)
  • func (b CodeBlocks) Lookup(name string) *CodeBlock
  • func (b CodeBlocks) Names() (result []string)
• type Document
  • func New(source []byte, renderer Renderer) *Document
  • func (d *Document) Parse() (*Node, ast.Node, error)
• type InnerBlock
  • func (InnerBlock) Kind() BlockKind
  • func (b *InnerBlock) Unwrap() ast.Node
  • func (b *InnerBlock) Value() []byte
• type MarkdownBlock
  • func (MarkdownBlock) Kind() BlockKind
  • func (b *MarkdownBlock) Unwrap() ast.Node
  • func (b *MarkdownBlock) Value() []byte
• type Node
  • func FindNode(node *Node, fn func(*Node) bool) *Node
  • func (n *Node) Bytes() []byte
  • func (n *Node) Children() []*Node
  • func (n *Node) Index() int
  • func (n *Node) InsertAt(idx int, item Block) *Node
  • func (n *Node) Item() Block
  • func (n *Node) Parent() *Node
  • func (n *Node) Remove(nodeToRemove *Node) bool
  • func (n *Node) String() string
• type Renderer

Types

type Block

type Block interface {
	Kind() BlockKind
	Unwrap() ast.Node
	Value() []byte
}

type BlockKind

type BlockKind int

const (
	InnerBlockKind BlockKind = iota + 1
	CodeBlockKind
	MarkdownBlockKind
)

type Blocks

type Blocks []Block

type CodeBlock

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

func (*CodeBlock) Attributes

func (b *CodeBlock) Attributes() map[string]string

func (*CodeBlock) Content

func (b *CodeBlock) Content() []byte

func (*CodeBlock) Intro

func (b *CodeBlock) Intro() string

func (CodeBlock) Kind

func (CodeBlock) Kind() BlockKind

func (*CodeBlock) Language

func (b *CodeBlock) Language() string

func (*CodeBlock) Lines

func (b *CodeBlock) Lines() []string

func (*CodeBlock) Name

func (b *CodeBlock) Name() string

func (*CodeBlock) Unwrap

func (b *CodeBlock) Unwrap() ast.Node

func (*CodeBlock) Value

func (b *CodeBlock) Value() []byte

type CodeBlocks

type CodeBlocks []*CodeBlock

func CollectCodeBlocks

func CollectCodeBlocks(node *Node) (result CodeBlocks)

func (CodeBlocks) Lookup

func (b CodeBlocks) Lookup(name string) *CodeBlock

func (CodeBlocks) Names

func (b CodeBlocks) Names() (result []string)

type Document

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

func New

func New(source []byte, renderer Renderer) *Document

func (*Document) Parse

func (d *Document) Parse() (*Node, ast.Node, error)

type InnerBlock

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

InnerBlock represents a non-leaf block. It helps to handle nested fenced code blocks for block quotes and list items.

func (InnerBlock) Kind

func (InnerBlock) Kind() BlockKind

func (*InnerBlock) Unwrap

func (b *InnerBlock) Unwrap() ast.Node

func (*InnerBlock) Value

func (b *InnerBlock) Value() []byte

type MarkdownBlock

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

func (MarkdownBlock) Kind

func (MarkdownBlock) Kind() BlockKind

func (*MarkdownBlock) Unwrap

func (b *MarkdownBlock) Unwrap() ast.Node

func (*MarkdownBlock) Value

func (b *MarkdownBlock) Value() []byte

type Node

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

func FindNode

func FindNode(node *Node, fn func(*Node) bool) *Node

func (*Node) Bytes

func (n *Node) Bytes() []byte

func (*Node) Children

func (n *Node) Children() []*Node

func (*Node) Index

func (n *Node) Index() int

func (*Node) InsertAt

func (n *Node) InsertAt(idx int, item Block) *Node

func (*Node) Item

func (n *Node) Item() Block

func (*Node) Parent

func (n *Node) Parent() *Node

func (*Node) Remove

func (n *Node) Remove(nodeToRemove *Node) bool

func (*Node) String

func (n *Node) String() string

type Renderer

type Renderer func(ast.Node, []byte) ([]byte, error)