mirror of
https://github.com/gohugoio/hugo.git
synced 2025-03-28 03:24:18 +00: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
|
||
|---|---|---|
| .. | ||
| filesystems | ||
| pagemeta | ||
| paths | ||
| testdata | ||
| testsite | ||
| 404_test.go | ||
| alias.go | ||
| alias_test.go | ||
| author.go | ||
| case_insensitive_test.go | ||
| collections.go | ||
| collections_test.go | ||
| config.go | ||
| config_test.go | ||
| configdir_test.go | ||
| datafiles_test.go | ||
| disableKinds_test.go | ||
| embedded_shortcodes_test.go | ||
| embedded_templates_test.go | ||
| fileInfo.go | ||
| gitinfo.go | ||
| hugo_sites.go | ||
| hugo_sites_build.go | ||
| hugo_sites_build_errors_test.go | ||
| hugo_sites_build_test.go | ||
| hugo_sites_multihost_test.go | ||
| hugo_themes_test.go | ||
| language_content_dir_test.go | ||
| media.go | ||
| menu.go | ||
| menu_test.go | ||
| minify_publisher_test.go | ||
| multilingual.go | ||
| orderedMap.go | ||
| orderedMap_test.go | ||
| page.go | ||
| page_content.go | ||
| page_errors.go | ||
| page_output.go | ||
| page_paths.go | ||
| page_paths_test.go | ||
| page_permalink_test.go | ||
| page_ref.go | ||
| page_resource.go | ||
| page_taxonomy_test.go | ||
| page_test.go | ||
| page_time_integration_test.go | ||
| page_without_content.go | ||
| pagebundler.go | ||
| pagebundler_capture.go | ||
| pagebundler_capture_test.go | ||
| pagebundler_handlers.go | ||
| pagebundler_test.go | ||
| pageCache.go | ||
| pageCache_test.go | ||
| pagecollections.go | ||
| pagecollections_test.go | ||
| pageGroup.go | ||
| pageGroup_test.go | ||
| pages_language_merge.go | ||
| pages_language_merge_test.go | ||
| pages_related.go | ||
| pages_related_test.go | ||
| pageSort.go | ||
| pageSort_test.go | ||
| pagesPrevNext.go | ||
| pagesPrevNext_test.go | ||
| pagination.go | ||
| pagination_test.go | ||
| path_separators_test.go | ||
| permalinker.go | ||
| permalinks.go | ||
| permalinks_test.go | ||
| prune_resources.go | ||
| resource_chain_test.go | ||
| robotstxt_test.go | ||
| rss_test.go | ||
| shortcode.go | ||
| shortcode_test.go | ||
| site.go | ||
| site_benchmark_test.go | ||
| site_output.go | ||
| site_output_test.go | ||
| site_render.go | ||
| site_sections.go | ||
| site_sections_test.go | ||
| site_stats_test.go | ||
| site_test.go | ||
| site_url_test.go | ||
| siteJSONEncode_test.go | ||
| sitemap.go | ||
| sitemap_test.go | ||
| taxonomy.go | ||
| taxonomy_test.go | ||
| template_engines_test.go | ||
| template_test.go | ||
| testhelpers_test.go | ||
| translations.go | ||