pager

Documentation

Index

• Constants
• func FormatSanitize(kind string) string
• func FormatToLeadRune(kind string) rune
• func HandleHeadMetaData(datum []byte) (interface{}, error)
• func HandleJsonMetaData(datum []byte) (interface{}, error)
• func HandleTomlMetaData(datum []byte) (interface{}, error)
• func HandleYamlMetaData(datum []byte) (interface{}, error)
• func InterfaceToConfig(in interface{}, mark rune) ([]byte, error)
• func InterfaceToFrontMatter(in interface{}, mark rune) ([]byte, error)
• type Content
• type FrontMatter
• type FrontmatterType
  • func DetectFrontMatter(mark rune) (f *FrontmatterType)
• type Page
  • func ReadFrom(r io.Reader) (p Page, err error)

Constants

const (
	HTML_LEAD       = "<"
	YAML_LEAD       = "-"
	YAML_DELIM_UNIX = "---\n"
	YAML_DELIM_DOS  = "---\r\n"
	YAML_DELIM      = "---"
	TOML_LEAD       = "#"
	TOML_DELIM_UNIX = "###\n"
	TOML_DELIM_DOS  = "###\r\n"
	TOML_DELIM      = "###"
	HEAD_LEAD       = "+"
	HEAD_DELIM_UNIX = "+++\n"
	HEAD_DELIM_DOS  = "+++\r\n"
	HEAD_DELIM      = "+++"
	JSON_LEAD       = "{"
)

Functions

func FormatSanitize

func FormatSanitize(kind string) string

func FormatToLeadRune

func FormatToLeadRune(kind string) rune

func HandleHeadMetaData

func HandleHeadMetaData(datum []byte) (interface{}, error)

func HandleJsonMetaData

func HandleJsonMetaData(datum []byte) (interface{}, error)

func HandleTomlMetaData

func HandleTomlMetaData(datum []byte) (interface{}, error)

func HandleYamlMetaData

func HandleYamlMetaData(datum []byte) (interface{}, error)

func InterfaceToConfig

func InterfaceToConfig(in interface{}, mark rune) ([]byte, error)

func InterfaceToFrontMatter

func InterfaceToFrontMatter(in interface{}, mark rune) ([]byte, error)

Types

type Content

type Content []byte

type FrontMatter

type FrontMatter []byte

type FrontmatterType

type FrontmatterType struct {
	Parse func([]byte) (interface{}, error)
	// contains filtered or unexported fields
}

func DetectFrontMatter

func DetectFrontMatter(mark rune) (f *FrontmatterType)

type Page

type Page interface {
	FrontMatter() FrontMatter
	Content() Content
	IsRenderable() bool
	Metadata() (interface{}, error)
}

func ReadFrom

func ReadFrom(r io.Reader) (p Page, err error)

ReadFrom reads the content from an io.Reader and constructs a page.