Documentation ¶
Index ¶
- Variables
- func FromFileToMap(fs afero.Fs, filename string) (map[string]interface{}, error)
- func GetNumWorkerMultiplier() int
- func GetStringSlicePreserveString(cfg Provider, key string) []string
- func IsValidConfigFilename(filename string) bool
- func RenameKeys(m map[string]interface{})
- func SetBaseTestDefaults(cfg Provider)
- func SetEnvVars(oldVars *[]string, keyValues ...string)
- func SplitEnvVar(v string) (string, string)
- type Build
- type Headers
- type KeyParams
- type Provider
- func FromConfigString(config, configType string) (Provider, error)
- func FromFile(fs afero.Fs, filename string) (Provider, error)
- func LoadConfigFromDir(sourceFs afero.Fs, configDir, environment string) (Provider, []string, error)
- func New() Provider
- func NewCompositeConfig(base, layer Provider) Provider
- func NewFrom(params maps.Params) Provider
- type Redirect
- type Server
- type Sitemap
Constants ¶
This section is empty.
Variables ¶
var ( // ConfigRootKeysSet contains all of the config map root keys. ConfigRootKeysSet = map[string]bool{ "build": true, "caches": true, "cascade": true, "frontmatter": true, "languages": true, "imaging": true, "markup": true, "mediatypes": true, "menus": true, "minify": true, "module": true, "outputformats": true, "params": true, "permalinks": true, "related": true, "sitemap": true, "privacy": true, "security": true, "taxonomies": true, } // ConfigRootKeys is a sorted version of ConfigRootKeysSet. ConfigRootKeys []string )
var DefaultBuild = Build{ UseResourceCacheWhen: "fallback", WriteStats: false, }
var (
ValidConfigFileExtensions = []string{"toml", "yaml", "yml", "json"}
)
Functions ¶
func FromFileToMap ¶ added in v0.54.0
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
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
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
SetEnvVars sets vars on the form key=value in the oldVars slice.
func SplitEnvVar ¶ added in v0.56.0
Types ¶
type Build ¶ added in v0.66.0
type Build struct { UseResourceCacheWhen string // never, fallback, always. Default is fallback // When enabled, will collect and write a hugo_stats.json with some build // related aggregated data (e.g. CSS class names). WriteStats bool // Can be used to toggle off writing of the intellinsense /assets/jsconfig.js // file. NoJSConfigInAssets bool }
Build holds some build related configuration.
func DecodeBuild ¶ added in v0.66.0
func (Build) UseResourceCache ¶ added in v0.66.0
type Provider ¶
type Provider interface { GetString(key string) string GetInt(key string) int GetBool(key string) bool GetParams(key string) maps.Params 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{}) Merge(key string, value interface{}) SetDefaults(params maps.Params) SetDefaultMergeStrategy() WalkParams(walkFn func(params ...KeyParams) bool) IsSet(key string) bool }
Provider provides the configuration settings for Hugo.
func FromConfigString ¶ added in v0.42.1
FromConfigString creates a config from the given YAML, JSON or TOML config. This is useful in tests.
func LoadConfigFromDir ¶ added in v0.84.0
func New ¶ added in v0.84.0
func New() Provider
New creates a Provider backed by an empty maps.Params.
func NewCompositeConfig ¶ added in v0.84.0
NewCompositeConfig creates a new composite Provider with a read-only base and a writeable layer.
type Server ¶ added in v0.67.0
type Server struct { Headers []Headers Redirects []Redirect // contains filtered or unexported fields }
Config for the dev server.
func DecodeServer ¶ added in v0.67.0
func (*Server) MatchHeaders ¶ added in v0.72.0
func (s *Server) MatchHeaders(pattern string) []types.KeyValueStr