sample_mk

package

v1.4.0 Latest Latest Go to latest Published: Jul 19, 2023 License: Apache-2.0 Imports: 1 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sinlov-go/sample-markdown

Links

Open Source Insights

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
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 ¶

View Source

const (
	NodeTypeBasic = 1 + iota
	NodeTypeHeader
	NodeTypeListItem
)

Variables ¶

This section is empty.

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 ¶ added in v1.2.0

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 (h Header) Level() int

func (h Header) String() string

Example: # Your title

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 ¶ added in v1.2.0

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

Source Files ¶

View all Source files

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