page

Documentation

Overview

Package page implements page parsing and generation.

Index

• func Minify(mimetype, src string) (string, error)
• func ParseTemplates(tpls []string) error
• type Frontmatter
• type Page
  • func ParseFile(src string, css string) (*Page, error)
  • func (p *Page) Generate(dst string) (err error)

Functions

func Minify

func Minify(mimetype, src string) (string, error)

Minify minifies file src with the type mimetype, returning an error otherwise.

func ParseTemplates

func ParseTemplates(tpls []string) error

ParseTemplates parses templates tpls into template tpl, returning an error otherwise.

Types

type Frontmatter

type Frontmatter struct {
	URI         string            `yaml:"uri"`
	Title       string            `yaml:"title"`
	Description string            `yaml:"description"`
	MetaTags    map[string]string `yaml:"meta_tags"`
	Template    string            `yaml:"template"`
}

Frontmatter represents a page frontmatter.

type Page

type Page struct {
	Ext         string
	Body        string
	CSS         string
	Frontmatter *Frontmatter
	// contains filtered or unexported fields
}

Page represents a parsed page.

func ParseFile

func ParseFile(src string, css string) (*Page, error)

ParseFile parses page source file and returns Page or an error.

func (*Page) Generate

func (p *Page) Generate(dst string) (err error)

Generate generates HTML from a parsed page and writes it to dst, returning an error otherwise.