hugo/docs/content/en/getting-started/configuration.md at 9beb61416cb51a1ff111ca52f2486210ab825f03

mirror of https://github.com/gohugoio/hugo.git synced 2024-07-02 15:20:28 +00:00

Bjørn Erik Pedersen 5fd1e74903

Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'

```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925

2024-01-27 10:48:57 +01:00

30 KiB

Raw Blame History

title

linkTitle

description

Configuration file

Create a site configuration file in the root of your project directory, naming it hugo.toml, hugo.yaml, or hugo.json, with that order of precedence.

my-project/
└── hugo.toml

{{% note %}} With v0.109.0 and earlier the basename of the site configuration file was config instead of hugo. You can use either, but should transition to the new naming convention when practical. {{% /note %}}

A simple example:

{{< code-toggle file=hugo >}} baseURL = 'https://example.org/' languageCode = 'en-us' title = 'ABC Widgets, Inc.' [params] subtitle = 'The Best Widgets on Earth' [params.contact] email = 'info@example.org' phone = '+1 202-555-1212' {{< /code-toggle >}}

To use a different configuration file when building your site, use the --config flag:

hugo --config other.toml

Combine two or more configuration files, with left-to-right precedence:

hugo --config a.toml,b.yaml,c.json

{{% note %}} See the specifications for each file format: TOML, YAML, and JSON.

Configuration directory

Instead of a single site configuration file, split your configuration by environment, root configuration key, and language. For example:

my-project/
└── config/
    ├── _default/
    │   ├── hugo.toml
    │   ├── menus.en.toml
    │   ├── menus.de.toml
    │   └── params.toml
    ├── production/
    │   ├── hugo.toml
    │   └── params.toml
    └── staging/
        ├── hugo.toml
        └── params.toml

The root configuration keys are build, caches, cascade, deployment, frontmatter, imaging, languages, markup, mediatypes, menus, minify, module, outputformats, outputs, params, permalinks, privacy, related, security, server, services, sitemap, and taxonomies.

Omit the root key

When splitting the configuration by root key, omit the root key in the given file. For example, these are equivalent:

{{< code-toggle file=hugo >}} [params] foo = 'bar' {{< /code-toggle >}}

{{< code-toggle file=params >}} foo = 'bar' {{< /code-toggle >}}

Recursive parsing

Hugo parses the config directory recursively, allowing you to organize the files into subdirectories. For example:

my-project/
└── config/
    └── _default/
        ├── navigation/
        │   ├── menus.de.toml
        │   └── menus.en.toml
        └── hugo.toml

Example

my-project/
└── config/
    ├── _default/
    │   ├── hugo.toml
    │   ├── menus.en.toml
    │   ├── menus.de.toml
    │   └── params.toml
    ├── production/
    │   ├── hugo.toml
    │   └── params.toml
    └── staging/
        ├── hugo.toml
        └── params.toml

Considering the structure above, when running hugo --environment staging, Hugo will use every setting 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 a Google tag ID in your site configuration:

{{< code-toggle file=hugo copy=false >}} [services.googleAnalytics] ID = 'G-XXXXXXXXX' {{< /code-toggle >}}

Now consider the following scenario:

You don't want to load the analytics code when running hugo server.
You want to use different Google tag IDs for your production and staging environments. For example:
- G-PPPPPPPPP for production
- G-SSSSSSSSS for staging

To satisfy these requirements, configure your site as follows:

config/_default/hugo.toml

Exclude the services.googleAnalytics section. This will prevent loading of the analytics code when you run hugo server.

By default, Hugo sets its environment to development when running hugo server. In the absence of a config/development directory, Hugo uses the config/_default directory.
config/production/hugo.toml

Include this section only:

{{< code-toggle file=hugo copy=false >}} [services.googleAnalytics] ID = 'G-PPPPPPPPP' {{< /code-toggle >}}

You do not need to include other parameters in this file. Include only those parameters that are specific to your production environment. Hugo will merge these parameters with the default configuration.

By default, Hugo sets its environment to production when running hugo. The analytics code will use the G-PPPPPPPPP tag ID.
config/staging/hugo.toml

Include this section only:

{{< code-toggle file=hugo copy=false >}} [services.googleAnalytics] ID = 'G-SSSSSSSSS' {{< /code-toggle >}}

You do not need to include other parameters in this file. Include only those parameters that are specific to your staging environment. Hugo will merge these parameters with the default configuration.

To build your staging site, run hugo --environment staging. The analytics code will use the G-SSSSSSSSS tag ID.

Merge configuration from themes

The configuration value for _merge can be one of:

none: No merge.
shallow: Only add values for new keys.
deep: Add values for new keys, merge existing.

Note that you don't need to be so verbose as in the default setup below; a _merge value higher up will be inherited if not set.

{{< code-toggle file=hugo dataKey="config_helpers.mergeStrategy" skipHeader=true />}}

All configuration settings

archetypeDir

(string) The directory where Hugo finds archetype files (content templates). Default is archetypes. {{% module-mounts-note %}}

assetDir

(string) The directory where Hugo finds asset files used in Hugo Pipes. Default is assets. {{% module-mounts-note %}}

baseURL

(string) The absolute URL (protocol, host, path, and trailing slash) of your published site (e.g., https://www.example.org/docs/).

build

See Configure Build.

buildDrafts

(bool) Include drafts when building. Default is false.

buildExpired

(bool) Include content already expired. Default is false.

buildFuture

(bool) Include content with publishdate in the future. Default is false.

caches

See Configure File Caches.

cascade

Pass down down default configuration values (front matter) to pages in the content tree. The options in site config is the same as in page front matter, see Front Matter Cascade.

{{% note %}} For a website in a single language, define the [[cascade]] in Front Matter. For a multilingual website, define the [[cascade]] in Site Config.

To remain consistent and prevent unexpected behavior, do not mix these strategies. {{% /note %}}

canonifyURLs

(bool) Enable to turn relative URLs into absolute. Default is false. See details.

cleanDestinationDir

(bool) When building, removes files from destination not found in static directories. Default is false.

contentDir

(string) The directory from where Hugo reads content files. Default is content. {{% module-mounts-note %}}

copyright

(string) Copyright notice for your site, typically displayed in the footer.

dataDir

(string) The directory from where Hugo reads data files. Default is data. {{% module-mounts-note %}}

defaultContentLanguage

(string) Content without language indicator will default to this language. Default is en.

defaultContentLanguageInSubdir

(bool) Render the default content language in subdir, e.g. content/en/. The site root / will then redirect to /en/. Default is false.

disableAliases

(bool) Will disable generation of alias redirects. Note that even if disableAliases is set, the aliases themselves are preserved on the page. The motivation with this is to be able to generate 301 redirects in an .htaccess, a Netlify _redirects file or similar using a custom output format. Default is false.

disableHugoGeneratorInject

(bool) Hugo will, by default, inject a generator meta tag in the HTML head on the home page only. You can turn it off, but we would really appreciate if you don't, as this is a good way to watch Hugo's popularity on the rise. Default is false.

disableKinds

(string slice) Disable rendering of the specified page kinds, any of 404, home, page, robotstxt, rss, section, sitemap, taxonomy, or term.

disableLiveReload

(bool) Disable automatic live reloading of browser window. Default is false.

disablePathToLower

(bool) Do not convert the url/path to lowercase. Default is false.

enableEmoji

(bool) Enable Emoji emoticons support for page content; see the emoji shortcode quick reference guide. Default is false.

enableGitInfo

(bool) Enable .GitInfo object for each page (if the Hugo site is versioned by Git). This will then update the Lastmod parameter for each page using the last git commit date for that content file. Default is false.

enableMissingTranslationPlaceholders

(bool) Show a placeholder instead of the default value or an empty string if a translation is missing. Default is false.

enableRobotsTXT

(bool) Enable generation of robots.txt file. Default is false.

frontmatter

See Front matter Configuration.

hasCJKLanguage

(bool) If true, auto-detect Chinese/Japanese/Korean Languages in the content. This will make .Summary and .WordCount behave correctly for CJK languages. Default is false.

imaging

See image processing configuration.

languageCode

(string) A language tag as defined by RFC 5646. This value is used to populate:

The <language> element in the internal RSS template
The lang attribute of the <html> element in the internal alias template

module

Module configuration see module configuration.

newContentEditor

(string) The editor to use when creating new content.

noChmod

(bool) Don't sync permission mode of files. Default is false.

noTimes

(bool) Don't sync modification time of files. Default is false.

outputFormats

See Configure Output Formats.

paginate

(int) Default number of elements per page in pagination. Default is 10.

paginatePath

(string) The path element used during pagination (https://example.org/page/2). Default is page.

permalinks

See Content Management.

pluralizeListTitles

(bool) Pluralize titles in lists. Default is true.

publishDir

(string) The directory to where Hugo will write the final static site (the HTML files etc.). Default is public.

See Related Content.

relativeURLs

(bool) Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. Default is false. See details.

refLinksErrorLevel

(string) When using ref or relref to resolve page links and a link cannot be resolved, it will be logged with this log level. Valid values are ERROR (default) or WARNING. Any ERROR will fail the build (exit -1). Default is ERROR.

refLinksNotFoundURL

(string) URL to be used as a placeholder when a page reference cannot be found in ref or relref. Is used as-is.

removePathAccents

(bool) Removes non-spacing marks from composite characters in content paths. Default is false.

content/post/hügó.md → https://example.org/post/hugo/

sectionPagesMenu

See Menus.

security

See Security Policy.

sitemap

Default sitemap configuration.

summaryLength

(int) The length of text in words to show in a .Summary. Default is 70.

taxonomies

See Configure Taxonomies.

theme

See module configuration for how to import a theme.

themesDir

(string) The directory where Hugo reads the themes from. Default is themes.

timeout

(string) Timeout for generating page contents, specified as a duration or in seconds. Note: this is used to bail out of recursive content generation. You might need to raise this limit if your pages are slow to generate (e.g., because they require large image processing or depend on remote contents). Default is 30s.

timeZone

(string) The time zone (or location), e.g. Europe/Oslo, used to parse front matter dates without such information and in the time function. The list of valid values may be system dependent, but should include UTC, Local, and any location in the IANA Time Zone database.

title

(string) Site title.

titleCaseStyle

(string) Default is ap. See Configure Title Case.

uglyURLs

(bool) When enabled, creates URL of the form /filename.html instead of /filename/. Default is false.

watch

(bool) Watch filesystem for changes and recreate as needed. Default is false.

{{% note %}} If you are developing your site on a *nix machine, here is a handy shortcut for finding a configuration option from the command line:

cd ~/sites/yourhugosite
hugo config | grep emoji

which shows output like

enableemoji: true

Configure build

The build configuration section contains global build-related configuration options.

buildStats {{< new-in 0.115.1 >}}: When enabled, creates a hugo_stats.json file in the root of your project. This file contains arrays of the class attributes, id attributes, and tags of every HTML element within your published site. Use this file as data source when removing unused CSS from your site. This process is also known as pruning, purging, or tree shaking.

Exclude class attributes, id attributes, or tags from hugo_stats.json with the disableClasses, disableIDs, and disableTags keys.

{{% note %}} With v0.115.0 and earlier this feature was enabled by setting writeStats to true. Although still functional, the writeStats key will be deprecated in a future release.

Given that CSS purging is typically limited to production builds, place the buildStats object below config/production.

Built for speed, there may be "false positive" detections (e.g., HTML elements that are not HTML elements) while parsing the published site. These "false positives" are infrequent and inconsequential. {{% /note %}}

Due to the nature of partial server builds, new HTML entities are added while the server is running, but old values will not be removed until you restart the server or run a regular hugo build.

cachebusters: See Configure Cache Busters
noJSConfigInAssets: Turn off writing a jsconfig.json into your /assets folder with mapping of imports from running js.Build. This file is intended to help with intellisense/navigation inside code editors such as VS Code. Note that if you do not use js.Build, no file will be written.
useResourceCacheWhen: When to use the cached resources in /resources/_gen for PostCSS and ToCSS. Valid values are never, always and fallback. The last value means that the cache will be tried if PostCSS/extended version is not available.

Configure cache busters

The build.cachebusters configuration option was added to support development using Tailwind 3.x's JIT compiler where a build configuration may look like this:

{{< code-toggle file=hugo >}} [build] [build.buildStats] enable = true build.cachebusters source = "assets/watching/hugo_stats\.json" target = "styles\.css" build.cachebusters source = "(postcss|tailwind)\.config\.js" target = "css" build.cachebusters source = "assets/.\.(js|ts|jsx|tsx)" target = "js" build.cachebusters source = "assets/.\.(.*)$" target = "$1" {{< /code-toggle >}}

When buildStats {{< new-in 0.115.1 >}} is enabled, Hugo writes a hugo_stats.json file on each build with HTML classes etc. that's used in the rendered output. Changes to this file will trigger a rebuild of the styles.css file. You also need to add hugo_stats.json to Hugo's server watcher. See Hugo Starter Tailwind Basic for a running example.

source: A regexp matching file(s) relative to one of the virtual component directories in Hugo, typically assets/....
target: A regexp matching the keys in the resource cache that should be expired when source changes. You can use the matching regexp groups from source in the expression, e.g. $1.

Configure server

This is only relevant when running hugo server, and it allows to set HTTP headers during development, which allows you to test out your Content Security Policy and similar. The configuration format matches Netlify's with slightly more powerful Glob matching:

{{< code-toggle file=hugo >}} [server] server.headers for = "/**"

[server.headers.values] X-Frame-Options = "DENY" X-XSS-Protection = "1; mode=block" X-Content-Type-Options = "nosniff" Referrer-Policy = "strict-origin-when-cross-origin" Content-Security-Policy = "script-src localhost:1313" {{< /code-toggle >}}

Since this is "development only", it may make sense to put it below the development environment:

{{< code-toggle file=config/development/server >}} headers for = "/**"

[headers.values] X-Frame-Options = "DENY" X-XSS-Protection = "1; mode=block" X-Content-Type-Options = "nosniff" Referrer-Policy = "strict-origin-when-cross-origin" Content-Security-Policy = "script-src localhost:1313" {{< /code-toggle >}}

You can also specify simple redirects rules for the server. The syntax is again similar to Netlify's.

Note that a status code of 200 will trigger a URL rewrite, which is what you want in SPA situations, e.g:

{{< code-toggle file=config/development/server >}} redirects from = "/myspa/**" to = "/myspa/" status = 200 force = false {{< /code-toggle >}}

Setting force=true will make a redirect even if there is existing content in the path. Note that before Hugo 0.76 force was the default behavior, but this is inline with how Netlify does it.

404 server error page

Hugo will, by default, render all 404 errors when running hugo server with the 404.html template. Note that if you have already added one or more redirects to your server configuration, you need to add the 404 redirect explicitly, e.g:

{{< code-toggle file=config/development/server >}} redirects from = "/**" to = "/404.html" status = 404 {{< /code-toggle >}}

Configure title case

By default, Hugo follows the capitalization rules published in the Associated Press Stylebook when creating automatic section titles, and when transforming strings with the strings.Title function.

Change this behavior by setting titleCaseStyle in your site configuration to any of the values below:

ap: Use the capitalization rules published in the Associated Press Stylebook.
chicago: Use the capitalization rules published in the Chicago Manual of Style.
go: Capitalize the first letter of every word.
firstupper: Capitalize the first letter of the first word.
none: Disable transformation of automatic section titles, and disable the transformation performed by the strings.Title function. This is useful if you would prefer to manually capitalize section titles as needed, and to bypass opinionated theme usage of the strings.Title function.

Configuration environment variables

HUGO_NUMWORKERMULTIPLIER: Can be set to increase or reduce the number of workers used in parallel processing in Hugo. If not set, the number of logical CPUs will be used.

Configure with environment variables

In addition to the 3 configuration options already mentioned, configuration key-values can be defined through operating system environment variables.

For example, the following command will effectively set a website's title on Unix-like systems:

$ env HUGO_TITLE="Some Title" hugo

This is really useful if you use a service such as Netlify to deploy your site. Look at the Hugo docs Netlify configuration file for an example.

{{% note %}} Names must be prefixed with HUGO_ and the configuration key must be set in uppercase when setting operating system environment variables.

To set configuration parameters, prefix the name with HUGO_PARAMS_ {{% /note %}}

If you are using snake_cased variable names, the above will not work. Hugo determines the delimiter to use by the first character after HUGO. This allows you to define environment variables on the form HUGOxPARAMSxAPI_KEY=abcdefgh, using any allowed delimiter.

Ignore content and data files when rendering

{{% note %}} This works, but we recommend you use the newer and more powerful includeFiles and excludeFiles mount options. {{% /note %}}

To exclude specific files from the content, data, and i18n directories when rendering your site, set ignoreFiles to one or more regular expressions to match against the absolute file path.

To ignore files ending with .foo or .boo:

{{< code-toggle file=hugo >}} ignoreFiles = ['.foo$', '.boo$'] {{< /code-toggle >}}

To ignore a file using the absolute file path:

{{< code-toggle file=hugo >}} ignoreFiles = ['^/home/user/project/content/test.md$'] {{< /code-toggle >}}

Configure front matter

Configure dates

Dates are important in Hugo, and you can configure how Hugo assigns dates to your content pages. You do this by adding a frontmatter section to your hugo.toml.

The default configuration is:

If you, as an example, have a non-standard date parameter in some of your content, you can override the setting for date:

{{< code-toggle file=hugo >}} [frontmatter] date = ["myDate", ":default"] {{< /code-toggle >}}

The :default is a shortcut to the default settings. The above will set .Date to the date value in myDate if present, if not we will look in date,publishDate, lastmod and pick the first valid date.

In the list to the right, values starting with ":" are date handlers with a special meaning (see below). The others are just names of date parameters (case insensitive) in your front matter configuration. Also note that Hugo have some built-in aliases to the above: lastmod => modified, publishDate => pubdate, published and expiryDate => unpublishdate. With that, as an example, using pubDate as a date in front matter, will, by default, be assigned to .PublishDate.

The special date handlers are:

:fileModTime: Fetches the date from the content file's last modification timestamp.

An example:

{{< code-toggle file=hugo >}} [frontmatter] lastmod = ["lastmod", ":fileModTime", ":default"] {{< /code-toggle >}}

The above will try first to extract the value for .Lastmod starting with the lastmod front matter parameter, then the content file's modification timestamp. The last, :default should not be needed here, but Hugo will finally look for a valid date in :git, date and then publishDate.

:filename: Fetches the date from the content file's file name. For example, 2018-02-22-mypage.md will extract the date 2018-02-22. Also, if slug is not set, mypage will be used as the value for .Slug.

An example:

{{< code-toggle file=hugo >}} [frontmatter] date = [":filename", ":default"] {{< /code-toggle >}}

The above will try first to extract the value for .Date from the file name, then it will look in front matter parameters date, publishDate and lastly lastmod.

:git: This is the Git author date for the last revision of this content file. This will only be set if --enableGitInfo is set or enableGitInfo = true is set in site configuration.

Configure additional output formats

Hugo v0.20 introduced the ability to render your content to multiple output formats (e.g., to JSON, AMP html, or CSV). See Output Formats for information on how to add these values to your Hugo project's configuration file.

Configure minify

See the tdewolff/minify project page for details.

Default configuration:

Configure file caches

Since Hugo 0.52 you can configure more than just the cacheDir. This is the default configuration:

You can override any of these cache settings in your own hugo.toml.

The keywords explained

cacheDir: (string) See Configure cacheDir.
project: (string) The base directory name of the current Hugo project. This means that, in its default setting, every project will have separated file caches, which means that when you do hugo --gc you will not touch files related to other Hugo projects running on the same PC.
resourceDir: (string) This is the value of the resourceDir configuration option.
maxAge: (string) This is the duration before a cache entry will be evicted, -1 means forever and 0 effectively turns that particular cache off. Uses Go's time.Duration, so valid values are "10s" (10 seconds), "10m" (10 minutes) and "10h" (10 hours).
dir: (string) The absolute path to where the files for this cache will be stored. Allowed starting placeholders are :cacheDir and :resourceDir (see above).

Configure cacheDir

This is the directory where Hugo by default will store its file caches. See Configure File Caches.

This can be set using the cacheDir config option or via the OS env variable HUGO_CACHEDIR.

If this is not set, Hugo will use, in order of preference:

If running on Netlify: /opt/build/cache/hugo_cache/. This means that if you run your builds on Netlify, all caches configured with :cacheDir will be saved and restored on the next build. For other CI vendors, please read their documentation. For an CircleCI example, see this configuration.
In a hugo_cache directory below the OS user cache directory as defined by Go's os.UserCacheDir. On Unix systems, this is $XDG_CACHE_HOME as specified by basedir-spec-latest if non-empty, else $HOME/.cache. On MacOS, this is $HOME/Library/Caches. On Windows, this is%LocalAppData%. On Plan 9, this is $home/lib/cache. {{< new-in 0.116.0 >}}
In a hugo_cache_$USER directory below the OS temp dir.

If you want to know the current value of cacheDir, you can run hugo config, e.g: hugo config | grep cachedir.

30 KiB Raw Blame History

Configuration file

Configuration directory

Omit the root key

Recursive parsing

Example

Merge configuration from themes

All configuration settings

archetypeDir

assetDir

baseURL

build

buildDrafts

buildExpired

buildFuture

caches

cascade

canonifyURLs

cleanDestinationDir

contentDir

copyright

dataDir

defaultContentLanguage

defaultContentLanguageInSubdir

disableAliases

disableHugoGeneratorInject

disableKinds

disableLiveReload

disablePathToLower

enableEmoji

enableGitInfo

enableMissingTranslationPlaceholders

enableRobotsTXT

frontmatter

hasCJKLanguage

imaging

languageCode

languages

disableLanguages

markup

mediaTypes

menus

minify

module

newContentEditor

noChmod

noTimes

outputFormats

paginate

paginatePath

permalinks

pluralizeListTitles

publishDir

related

relativeURLs

refLinksErrorLevel

refLinksNotFoundURL

removePathAccents

sectionPagesMenu

security

sitemap

summaryLength

taxonomies

theme

themesDir

timeout

timeZone

title

titleCaseStyle

uglyURLs

watch

Configure build

Configure cache busters

Configure server

404 server error page

Configure title case

Configuration environment variables

Configure with environment variables

Ignore content and data files when rendering

Configure front matter

30 KiB

Raw Blame History