mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-03 03:13:33 -05:00
7829474088
This commit adds support for a configuration directory (default `config`). The different pieces in this puzzle are:
* A new `--environment` (or `-e`) flag. This can also be set with the `HUGO_ENVIRONMENT` OS environment variable. The value for `environment` defaults to `production` when running `hugo` and `development` when running `hugo server`. You can set it to any value you want (e.g. `hugo server -e "Sensible Environment"`), but as it is used to load configuration from the file system, the letter case may be important. You can get this value in your templates with `{{ hugo.Environment }}`.
* A new `--configDir` flag (defaults to `config` below your project). This can also be set with `HUGO_CONFIGDIR` OS environment variable.
If the `configDir` exists, the configuration files will be read and merged on top of each other from left to right; the right-most value will win on duplicates.
Given the example tree below:
If `environment` is `production`, the left-most `config.toml` would be the one directly below the project (this can now be omitted if you want), and then `_default/config.toml` and finally `production/config.toml`. And since these will be merged, you can just provide the environment specific configuration setting in you production config, e.g. `enableGitInfo = true`. The order within the directories will be lexical (`config.toml` and then `params.toml`).
```bash
config
├── _default
│ ├── config.toml
│ ├── languages.toml
│ ├── menus
│ │ ├── menus.en.toml
│ │ └── menus.zh.toml
│ └── params.toml
├── development
│ └── params.toml
└── production
├── config.toml
└── params.toml
```
Some configuration maps support the language code in the filename (e.g. `menus.en.toml`): `menus` (`menu` also works) and `params`.
Also note that the only folders with "a meaning" in the above listing is the top level directories below `config`. The `menus` sub folder is just added for better organization.
We use `TOML` in the example above, but Hugo also supports `JSON` and `YAML` as configuration formats. These can be mixed.
Fixes #5422
67 lines
1.8 KiB
Go
67 lines
1.8 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package hugo
|
|
|
|
import (
|
|
"fmt"
|
|
"html/template"
|
|
)
|
|
|
|
const (
|
|
EnvironmentDevelopment = "development"
|
|
EnvironmentProduction = "production"
|
|
)
|
|
|
|
var (
|
|
// commitHash contains the current Git revision. Use make to build to make
|
|
// sure this gets set.
|
|
commitHash string
|
|
|
|
// buildDate contains the date of the current build.
|
|
buildDate string
|
|
)
|
|
|
|
// Info contains information about the current Hugo environment
|
|
type Info struct {
|
|
CommitHash string
|
|
BuildDate string
|
|
|
|
// The build environment.
|
|
// Defaults are "production" (hugo) and "development" (hugo server).
|
|
// This can also be set by the user.
|
|
// It can be any string, but it will be all lower case.
|
|
Environment string
|
|
}
|
|
|
|
// Version returns the current version as a comparable version string.
|
|
func (i Info) Version() VersionString {
|
|
return CurrentVersion.Version()
|
|
}
|
|
|
|
// Generator a Hugo meta generator HTML tag.
|
|
func (i Info) Generator() template.HTML {
|
|
return template.HTML(fmt.Sprintf(`<meta name="generator" content="Hugo %s" />`, CurrentVersion.String()))
|
|
}
|
|
|
|
// NewInfo creates a new Hugo Info object.
|
|
func NewInfo(environment string) Info {
|
|
if environment == "" {
|
|
environment = EnvironmentProduction
|
|
}
|
|
return Info{
|
|
CommitHash: commitHash,
|
|
BuildDate: buildDate,
|
|
Environment: environment,
|
|
}
|
|
}
|