hugo

Documentation

Index

• Variables
• func GetBool(matter *pageparser.ContentFrontMatter, key string) (bool, error)
• func GetContentPath(content string) (string, error)
• func GetString(matter *pageparser.ContentFrontMatter, key string) (string, error)
• func ParsePage(pagePath string) (pageparser.ContentFrontMatter, error)
• func ReadPage(r io.ReadCloser) (pageparser.ContentFrontMatter, error)
• func WritePage(w io.WriteCloser, page *pageparser.ContentFrontMatter) error
• type Config
• type ConfigOption
• type ConfigOptionFn
  • func (fn ConfigOptionFn) Apply(config *Config) error
• type Sites
  • func New(options ...ConfigOption) (*Sites, error)

Variables

var (
	KeyNotFoundError   = errors.New("key not set")
	KeyConversionError = errors.New("failed to convert key type")
)

Functions

func GetBool

func GetBool(matter *pageparser.ContentFrontMatter, key string) (bool, error)

func GetContentPath

func GetContentPath(content string) (string, error)

func GetString

func GetString(matter *pageparser.ContentFrontMatter, key string) (string, error)

func ParsePage

func ParsePage(pagePath string) (pageparser.ContentFrontMatter, error)

func ReadPage

func ReadPage(r io.ReadCloser) (pageparser.ContentFrontMatter, error)

func WritePage

func WritePage(w io.WriteCloser, page *pageparser.ContentFrontMatter) error

Types

type Config

type Config struct {
	CacheDir    string
	ConfigDir   string
	ConfigFile  string
	Environment string
	PublishDir  string
	ThemesDir   string
	WorkingDir  string
}

type ConfigOption

type ConfigOption interface {
	Apply(config *Config) error
}

type ConfigOptionFn

type ConfigOptionFn func(config *Config) error

func (ConfigOptionFn) Apply

func (fn ConfigOptionFn) Apply(config *Config) error

type Sites

type Sites struct {
	*hugolib.HugoSites
	ContentFactory hugolib.ContentFactory
}

func New

func New(options ...ConfigOption) (*Sites, error)