configuration

Documentation

Index

• Variables
• type Author
• type Configuration
  • func NewFromFile(configurationPath string) (configuration *Configuration, err error)
  • func (c *Configuration) AddPaths(layouts string, pages string, output string)
• type Site

Variables

var Authors map[string]Author

Types

type Author

type Author struct {
	FirstName string `yaml:"firstName"`
	LastName  string `yaml:"lastName"`
	Email     string `yaml:"email"`
	Twitter   string `yaml:"twitter"`
}

type Configuration

type Configuration struct {
	// Authors contains information about the sites authors.
	Authors map[string]Author `yaml:"authors"`
	// Site contains the configuration information for the site.
	Site Site `yaml:"site"`

	// Command Line Options
	LayoutsPath string
	PagesPath   string
	OutputPath  string

	Layouts map[string]layout.Layout

	SiteMap *sitemap.SitemapIndex

	// Other contains custom configuration options.
	Other map[string]interface{} `yaml:"-"`
}

func NewFromFile

func NewFromFile(configurationPath string) (configuration *Configuration, err error)

func (*Configuration) AddPaths

func (c *Configuration) AddPaths(layouts string, pages string, output string)

type Site

type Site struct {
	Name    string `yaml:"name"`
	BaseURL string `yaml:"baseURL"`
}