peyote

package module

v0.0.0-...-7d9bb2c Latest Latest Go to latest Published: Mar 18, 2023 License: ISC Imports: 10 Imported by: 1

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

git.sr.ht/~coyotes/peyote

Links

Open Source Insights

README ¶

peyote

cacti gemtext parser and writer

Documentation ¶

Index ¶

Constants
func WriteHTML(n Node, w io.Writer) error
type Metadata
type Metadatable
type Node
type NodeType
type Parser
- func NewParser(r io.ReadSeeker, md Metadatable) Parser
- func NewParserFromString(s string, md Metadatable) Parser
type ParserState

Constants ¶

View Source

const (
	PSNone         ParserState = iota
	PSMetadata                 = iota
	PSPreformatted             = iota
	PSBlockquote               = iota
	PSList                     = iota
)

View Source

const (
	NodeNil               NodeType = iota
	NodePara                       = iota
	NodeH1                         = iota
	NodeH2                         = iota
	NodeH3                         = iota
	NodeLink                       = iota
	NodeListStart                  = iota
	NodeListText                   = iota
	NodeListEnd                    = iota
	NodePreformattedStart          = iota
	NodePreformattedAlt            = iota
	NodePreformattedText           = iota
	NodePreformattedEnd            = iota
	NodeBlockquoteStart            = iota
	NodeBlockquoteText             = iota
	NodeBlockquoteEnd              = iota
)

Variables ¶

This section is empty.

Functions ¶

func WriteHTML ¶

func WriteHTML(n Node, w io.Writer) error

Types ¶

type Metadata ¶

type Metadata struct {
	Title   string
	Aside   string
	Special bool
	Date    time.Time
	Extra   map[string]string
}

type Metadatable ¶

type Metadatable interface {
	Set(key string, value string)
}

type Node ¶

type Node struct {
	Type NodeType
	Text string
	URL  string
}

type NodeType ¶

type NodeType uint16

type Parser ¶

type Parser struct {
	Metadata Metadatable
	// contains filtered or unexported fields
}

func NewParser ¶

func NewParser(r io.ReadSeeker, md Metadatable) Parser

func NewParserFromString ¶

func NewParserFromString(s string, md Metadatable) Parser

func (*Parser) Next ¶

func (gp *Parser) Next() bool

func (*Parser) Node ¶

func (gp *Parser) Node() Node

func (*Parser) ParseMetadata ¶

func (gp *Parser) ParseMetadata()

func (*Parser) Restart ¶

func (gp *Parser) Restart()

func (*Parser) WriteDocument ¶

func (gp *Parser) WriteDocument(w io.Writer, fn func(n Node, w io.Writer) error) error

type ParserState ¶

type ParserState uint16

Source Files ¶

View all Source files

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