sample_mk

Documentation

Index

• Constants
• func Equal(n1, n2 Node) bool
• func GenerateText(nodes []Node) string
• type BasicItem
  • func NewBasicItem(text string) BasicItem
  • func (i BasicItem) String() string
  • func (i BasicItem) Type() int
• type Header
  • func NewHeader(level int, text string) Header
  • func (h Header) Level() int
  • func (h Header) String() string
  • func (h Header) Type() int
• type ListItem
  • func NewListItem(text string) ListItem
  • func (i ListItem) String() string
  • func (i ListItem) Type() int
• type Node
  • func Parse(lines []string) []Node

Constants

const (
	NodeTypeBasic = 1 + iota
	NodeTypeHeader
	NodeTypeListItem
)

Functions

func Equal

func Equal(n1, n2 Node) bool

Equal compare two nodes by strings.EqualFold

func GenerateText

func GenerateText(nodes []Node) string

GenerateText return single string which represents all markdown nodes

Types

type BasicItem

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

BasicItem basic item node without any markdown-syntax

func NewBasicItem

func NewBasicItem(text string) BasicItem

NewBasicItem new basic item node

func (BasicItem) String

func (i BasicItem) String() string

func (BasicItem) Type

func (i BasicItem) Type() int

type Header

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

Header is markdown header node

func NewHeader

func NewHeader(level int, text string) Header

NewHeader new header node

level: header level will append headerToken as '#'

func (Header) Level

func (h Header) Level() int

func (Header) String

func (h Header) String() string

Example: # Your title

func (Header) Type

func (h Header) Type() int

type ListItem

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

func NewListItem

func NewListItem(text string) ListItem

func (ListItem) String

func (i ListItem) String() string

func (ListItem) Type

func (i ListItem) Type() int

type Node

type Node interface {
	// String return string representation of node
	String() string

	// Type return type of node
	Type() int
}

Node is single markdown syntax representation Example: Header, ListItem, BasicItem ...

func Parse

func Parse(lines []string) []Node

Parse

return all markdown nodes from lines