blogs/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2026-09-01 03:02:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

📄 Add more clarity on merging of config files (#1493)

Browse Source 
Co-authored-by: Christian Oliff <christianoliff@pm.me>
This commit is contained in:
Sidharth R
2022-09-12 06:37:40 +05:30
committed by GitHub
parent 2e82efff09
commit f4a1b38c76
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/getting-started/configuration.md
+21 -2
View File
@@ -4,7 +4,6 @@ linktitle: Configuration
description: How to configure your Hugo site.
date: 2013-07-01
publishdate: 2017-01-02
lastmod: 2017-03-05
categories: [getting started,fundamentals]
keywords: [configuration,toml,yaml,json]
menu:
@@ -18,7 +17,6 @@ aliases: [/overview/source-directory/,/overview/configuration/]
toc: true
---
## Configuration File
Hugo uses the `config.toml`, `config.yaml`, or `config.json` (if found in the
@@ -77,6 +75,27 @@ foo = "bar"
```
Considering the structure above, when running `hugo --environment staging`, Hugo will use every settings from `config/_default` and merge `staging`'s on top of those.
Let's take an example to understand this better. Let's say you are using Google Analytics for your website. This requires you to specify `googleAnalytics = "G-XXXXXXXX"` in `config.toml`. Now consider the following scenario:
- You don't want the Analytics code to be loaded in development i.e. in your `localhost`
- You want to use separate googleAnalytics IDs for your production & staging environments (say):
- `G-PPPPPPPP` for production
- `G-SSSSSSSS` for staging
This is how you need to configure your `config.toml` files considering the above scenario:
1. In `_default/config.toml` you don't need to mention `googleAnalytics` parameter at all. This ensures that no Google Analytics code is loaded in your development server i.e. when you run `hugo serve`. This works since, by default Hugo sets `Environment=development` when you run `hugo serve` which uses the config files from `_default` folder
2. In `production/config.toml` you just need to have one line:
```googleAnalytics = "G-PPPPPPPP"```
You don't need to mention all other parameters like `title`, `baseURL`, `theme` etc. again in this config file. You need to mention only those parameters which are different or new for the production environment. This is due to the fact that Hugo is going to __merge__ this on top of `_default/config.toml`. Now when you run `hugo` (build command), by default hugo sets `Environment=production`, so the `G-PPPPPPPP` analytics code will be there in your production website
3. Similarly in `staging/config.toml` you just need to have one line:
```googleAnalytics = "G-SSSSSSSS"```
Now you need to tell Hugo that you are using the staging environment. So your build command should be `hugo --environment staging` which will load the `G-SSSSSSSS` analytics code in your staging website
{{% note %}}
Default environments are __development__ with `hugo server` and __production__ with `hugo`.
{{%/ note %}}