config

package
v0.68.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2020 License: Apache-2.0 Imports: 17 Imported by: 410

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultBuild = Build{
	UseResourceCacheWhen: "fallback",
}
View Source
var (
	ValidConfigFileExtensions = []string{"toml", "yaml", "yml", "json"}
)

Functions

func FromFileToMap added in v0.54.0

func FromFileToMap(fs afero.Fs, filename string) (map[string]interface{}, error)

FromFileToMap is the same as FromFile, but it returns the config values as a simple map.

func GetNumWorkerMultiplier added in v0.55.0

func GetNumWorkerMultiplier() int

GetNumWorkerMultiplier returns the base value used to calculate the number of workers to use for Hugo's parallel execution. It returns the value in HUGO_NUMWORKERMULTIPLIER OS env variable if set to a positive integer, else the number of logical CPUs.

func GetStringSlicePreserveString added in v0.42.1

func GetStringSlicePreserveString(cfg Provider, key string) []string

GetStringSlicePreserveString returns a string slice from the given config and key. It differs from the GetStringSlice method in that if the config value is a string, we do not attempt to split it into fields.

func IsValidConfigFilename added in v0.54.0

func IsValidConfigFilename(filename string) bool

IsValidConfigFilename returns whether filename is one of the supported config formats in Hugo.

func RenameKeys added in v0.54.0

func RenameKeys(m map[string]interface{})

RenameKeys renames config keys in m recursively according to a global Hugo alias definition.

func SetBaseTestDefaults added in v0.55.0

func SetBaseTestDefaults(cfg Provider)

SetBaseTestDefaults provides some common config defaults used in tests.

func SetEnvVars added in v0.56.0

func SetEnvVars(oldVars *[]string, keyValues ...string)

SetEnvVars sets vars on the form key=value in the oldVars slice.

func SplitEnvVar added in v0.56.0

func SplitEnvVar(v string) (string, string)

Types

type Build added in v0.66.0

type Build struct {
	UseResourceCacheWhen string // never, fallback, always. Default is fallback
}

Build holds some build related condfiguration.

func DecodeBuild added in v0.66.0

func DecodeBuild(cfg Provider) Build

func (Build) UseResourceCache added in v0.66.0

func (b Build) UseResourceCache(err error) bool

type Headers added in v0.67.0

type Headers struct {
	For    string
	Values map[string]interface{}
}

type Provider

type Provider interface {
	GetString(key string) string
	GetInt(key string) int
	GetBool(key string) bool
	GetStringMap(key string) map[string]interface{}
	GetStringMapString(key string) map[string]string
	GetStringSlice(key string) []string
	Get(key string) interface{}
	Set(key string, value interface{})
	IsSet(key string) bool
}

Provider provides the configuration settings for Hugo.

func FromConfigString added in v0.42.1

func FromConfigString(config, configType string) (Provider, error)

FromConfigString creates a config from the given YAML, JSON or TOML config. This is useful in tests.

func FromFile added in v0.54.0

func FromFile(fs afero.Fs, filename string) (Provider, error)

FromFile loads the configuration from the given filename.

type Server added in v0.67.0

type Server struct {
	Headers []Headers
	// contains filtered or unexported fields
}

Config for the dev server.

func DecodeServer added in v0.67.0

func DecodeServer(cfg Provider) *Server

func (*Server) Match added in v0.67.0

func (s *Server) Match(pattern string) []types.KeyValueStr

type Sitemap added in v0.55.0

type Sitemap struct {
	ChangeFreq string
	Priority   float64
	Filename   string
}

Sitemap configures the sitemap to be generated.

func DecodeSitemap added in v0.55.0

func DecodeSitemap(prototype Sitemap, input map[string]interface{}) Sitemap

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL