context

Documentation

Index

• type FileFunc
• type IterationError
  • func (i IterationError) Error() string
• type Page
  • func CreatePage(path string) (*Page, error)
  • func GetHTMLs(sitePath string) ([]*Page, error)
  • func NewPage(path string, content []byte) *Page
  • func (p *Page) Hash() string
  • func (p *Page) Refresh() error
  • func (p *Page) String() string

Types

type FileFunc

type FileFunc func(*os.File, string) error

FileFunc is the action for iterating through all files

type IterationError

type IterationError []error

IterationError represents the net error output from the eachFile function

func (IterationError) Error

func (i IterationError) Error() string

type Page

type Page struct {
	Path    string
	Content string
	Html    string
}

Page is represents a markdown file, parsed into an HTML string, with a Path

func CreatePage

func CreatePage(path string) (*Page, error)

CreatePage is a function that fetches a page or returns an error

func GetHTMLs

func GetHTMLs(sitePath string) ([]*Page, error)

GetHTMLs is a function for building the whole page state thingy

func NewPage

func NewPage(path string, content []byte) *Page

NewPage is a constructor for a page type

func (*Page) Hash

func (p *Page) Hash() string

Hash returns a unique identefier for this page

func (*Page) Refresh

func (p *Page) Refresh() error

Refresh will fetch the updated content for this file

func (*Page) String

func (p *Page) String() string