github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Squashed 'docs/' changes from 39af43ef1..1798dc0d5

Browse source 
1798dc0d5 Update theme
403fa716e Update CLI documentation (#2092)
aade5a09e Correct media subtype example
53cd9dea6 netlify: Hugo 0.112.3
b78b86cb1 Add source/target warning to resources.Copy (#2091)
50c299729 netlify: Hugo 0.112.2
73197046f Change config.xxx to hugo.xxx throughout the documentation (#2090)
d489d4c6f Add hugo.WorkingDir to docs (#2089)
7487df809 Fix typos (#2088)
6d0572cd6 netlify: Hugo 0.112.1
6838600b2 netlify: Hugo 0.112.0
513e7a80f Merge branch 'tempv0.112.0'
91eb44275 Some more about 0.112.0
bd3b33a27 docs: Regen docshelper
fb3027daf docs: Regen CLI docs
8e7b8e987 Merge commit 'f96384a3b596f9bc0a3a035970b09b2c601f0ccb'
a942ceef4 tpl/tplimpl: Add img loading attribute to figure shortcode  (#10927)
0e0c7b25e tpl/urls: Return empty string when JoinPath has zero args
310ce949a tpl/urls: Add JoinPath template function
ae435ca77 tpl: Add math.Abs
f340139f8 Revert "Update syntax-highlighting.md (#10929)" (#10930)
917a0e24d Update syntax-highlighting.md (#10929)

git-subtree-dir: docs
git-subtree-split: 1798dc0d54ce048dd975863b490cd809ef14268a
This commit is contained in:
Bjørn Erik Pedersen 2023-05-27 16:59:59 +02:00
parent f96384a3b5
commit d3927310d5
90 changed files with 937 additions and 691 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers generated
View file

@ -3,6 +3,3 @@
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Referrer-Policy: origin-when-cross-origin
/*
Link: <{{ "dist/app.bundle.js" | relURL }}>; rel=preload; as=script
Link: <{{ "dist/main.css" | relURL }}>; rel=preload; as=style

2
_vendor/modules.txt
View file

@ -1 +1 @@
# github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11
# github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a

10
content/en/about/hugo-and-gdpr.md
View file

@ -27,9 +27,9 @@ toc: true
## All Privacy Settings
Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `config.toml`).
Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `hugo.toml`).
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[privacy]
[privacy.disqus]
disable = false
@ -58,7 +58,7 @@ privacyEnhanced = false
An example Privacy Config that disables all the relevant services in Hugo. With this configuration, the other settings will not matter.
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[privacy]
[privacy.disqus]
disable = true
@ -98,7 +98,7 @@ simple
**Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inline styles provided by Hugo:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[services]
[services.instagram]
disableInlineCSS = true
@ -114,7 +114,7 @@ simple
**Note:** If you use the _simple mode_ for Twitter, you may want to disable the inline styles provided by Hugo:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[services]
[services.twitter]
disableInlineCSS = true

3
content/en/commands/hugo.md
View file

@ -39,6 +39,7 @@ hugo [flags]
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed.
--format string preferred file format (toml, yaml or json) (default "toml")
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for hugo
--ignoreCache ignores the cache directory
@ -82,5 +83,5 @@ hugo [flags]
* [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers.
* [hugo new](/commands/hugo_new/) - Create new content for your site
* [hugo server](/commands/hugo_server/) - A high performance webserver
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info

2
content/en/commands/hugo_completion.md
View file

@ -26,7 +26,9 @@ See each sub-command's help for details on how to use the generated script.
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

2
content/en/commands/hugo_completion_bash.md
View file

@ -49,7 +49,9 @@ hugo completion bash
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

2
content/en/commands/hugo_completion_fish.md
View file

@ -40,7 +40,9 @@ hugo completion fish [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

2
content/en/commands/hugo_completion_powershell.md
View file

@ -37,7 +37,9 @@ hugo completion powershell [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_completion_zsh.md
View file

@ -18,7 +18,7 @@ to enable it. You can execute the following once:
To load completions in your current shell session:
source <(hugo completion zsh); compdef _hugo hugo
source <(hugo completion zsh)
To load completions for every new session, execute once:
@ -51,7 +51,9 @@ hugo completion zsh [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

14
content/en/commands/hugo_config.md
View file

@ -12,29 +12,31 @@ Print the site configuration
Print the site configuration, both default and custom settings.
```
hugo config [flags]
hugo config [command] [flags]
```
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for config
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

4
content/en/commands/hugo_config_mounts.md
View file

@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/
Print the configured file mounts
```
hugo config mounts [flags]
hugo config mounts [flags] [args]
```
### Options
@ -24,7 +24,9 @@ hugo config mounts [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

16
content/en/commands/hugo_convert.md
View file

@ -13,28 +13,34 @@ Convert your content (e.g. front matter) to different formats.
See convert's subcommands toJSON, toTOML and toYAML for more information.
```
hugo convert [command] [flags]
```
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for convert
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-o, --output string filesystem path to write files to
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
--unsafe enable less safe operations, please backup first
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

4
content/en/commands/hugo_convert_toJSON.md
View file

@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory
to use JSON for the front matter.
```
hugo convert toJSON [flags]
hugo convert toJSON [flags] [args]
```
### Options
@ -29,7 +29,9 @@ hugo convert toJSON [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_convert_toTOML.md
View file

@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory
to use TOML for the front matter.
```
hugo convert toTOML [flags]
hugo convert toTOML [flags] [args]
```
### Options
@ -29,7 +29,9 @@ hugo convert toTOML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_convert_toYAML.md
View file

@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory
to use YAML for the front matter.
```
hugo convert toYAML [flags]
hugo convert toYAML [flags] [args]
```
### Options
@ -29,7 +29,9 @@ hugo convert toYAML [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

16
content/en/commands/hugo_deploy.md
View file

@ -16,36 +16,38 @@ documentation.
```
hugo deploy [flags]
hugo deploy [flags] [args]
```
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--confirm ask for confirmation before making changes to the target
--dryRun dry run
-e, --environment string build environment
--force force upload of all files
-h, --help help for deploy
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--invalidateCDN invalidate the CDN cache listed in the deployment target (default true)
--maxDeletes int maximum # of files to delete, or -1 to disable (default 256)
--workers int number of workers to transfer files. (default 10)
-s, --source string filesystem path to read files relative from
--target string target deployment from deployments section in config file; defaults to the first one
--themesDir string filesystem path to themes directory
--workers int number of workers to transfer files. defaults to 10 (default 10)
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

9
content/en/commands/hugo_env.md
View file

@ -9,13 +9,10 @@ Print Hugo version and environment info
### Synopsis
Print Hugo version and environment info. This is useful in Hugo bug reports.
If you add the -v flag, you will get a full dependency list.
Print Hugo version and environment info. This is useful in Hugo bug reports
```
hugo env [flags]
hugo env [flags] [args]
```
### Options
@ -31,7 +28,9 @@ hugo env [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

6
content/en/commands/hugo_gen.md
View file

@ -7,6 +7,10 @@ url: /commands/hugo_gen/
A collection of several useful generators.
```
hugo gen [command] [flags]
```
### Options
```
@ -20,7 +24,9 @@ A collection of several useful generators.
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_gen_chromastyles.md
View file

@ -14,7 +14,7 @@ Generate CSS stylesheet for the Chroma code highlighter for a given style. This
See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles
```
hugo gen chromastyles [flags]
hugo gen chromastyles [flags] [args]
```
### Options
@ -33,7 +33,9 @@ hugo gen chromastyles [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

5
content/en/commands/hugo_gen_doc.md
View file

@ -10,7 +10,6 @@ Generate Markdown documentation for the Hugo CLI.
### Synopsis
Generate Markdown documentation for the Hugo CLI.
This command is, mostly, used to create up-to-date documentation
of Hugo's command-line interface for https://gohugo.io/.
@ -18,7 +17,7 @@ It creates one Markdown file per command with front matter suitable
for rendering in Hugo.
```
hugo gen doc [flags]
hugo gen doc [flags] [args]
```
### Options
@ -35,7 +34,9 @@ hugo gen doc [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_gen_man.md
View file

@ -14,7 +14,7 @@ command-line interface. By default, it creates the man page files
in the "man" directory under the current directory.
```
hugo gen man [flags]
hugo gen man [flags] [args]
```
### Options
@ -31,7 +31,9 @@ hugo gen man [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

6
content/en/commands/hugo_import.md
View file

@ -13,6 +13,10 @@ Import your site from other web site generators like Jekyll.
Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
```
hugo import [command] [flags]
```
### Options
```
@ -26,7 +30,9 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_import_jekyll.md
View file

@ -14,7 +14,7 @@ hugo import from Jekyll.
Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`.
```
hugo import jekyll [flags]
hugo import jekyll [flags] [args]
```
### Options
@ -31,7 +31,9 @@ hugo import jekyll [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

18
content/en/commands/hugo_list.md
View file

@ -11,28 +11,34 @@ Listing out various types of content
Listing out various types of content.
List requires a subcommand, e.g. `hugo list drafts`.
List requires a subcommand, e.g. hugo list drafts
```
hugo list [command] [flags]
```
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for list
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

4
content/en/commands/hugo_list_all.md
View file

@ -12,7 +12,7 @@ List all posts
List all of the posts in your content directory, include drafts, future and expired pages.
```
hugo list all [flags]
hugo list all [flags] [args]
```
### Options
@ -28,7 +28,9 @@ hugo list all [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_list_drafts.md
View file

@ -12,7 +12,7 @@ List all drafts
List all of the drafts in your content directory.
```
hugo list drafts [flags]
hugo list drafts [flags] [args]
```
### Options
@ -28,7 +28,9 @@ hugo list drafts [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_list_expired.md
View file

@ -12,7 +12,7 @@ List all posts already expired
List all of the posts in your content directory which has already expired.
```
hugo list expired [flags]
hugo list expired [flags] [args]
```
### Options
@ -28,7 +28,9 @@ hugo list expired [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_list_future.md
View file

@ -12,7 +12,7 @@ List all posts dated in the future
List all of the posts in your content directory which will be posted in the future.
```
hugo list future [flags]
hugo list future [flags] [args]
```
### Options
@ -28,7 +28,9 @@ hugo list future [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

41
content/en/commands/hugo_mod.md
View file

@ -10,7 +10,6 @@ Various Hugo Modules helpers.
### Synopsis
Various helpers to help manage the modules in your project's dependency graph.
Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git).
This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor".
@ -26,51 +25,25 @@ See https://gohugo.io/hugo-modules/ for more information.
### Options
```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for mod
--ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.)
--noBuildLock don't create .hugo_build.lock file
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--panicOnWarning panic on first WARNING log
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--printI18nWarnings print missing translations
--printMemoryUsage print memory usage to screen at intervals
--printPathWarnings print warnings on duplicate target paths etc.
--printUnusedTemplates print warnings on unused templates.
-s, --source string filesystem path to read files relative from
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general)
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

10
content/en/commands/hugo_mod_clean.md
View file

@ -11,14 +11,8 @@ Delete the Hugo Module cache for the current project.
Delete the Hugo Module cache for the current project.
Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo".
Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc".
```
hugo mod clean [flags]
hugo mod clean [flags] [args]
```
### Options
@ -36,7 +30,9 @@ hugo mod clean [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_mod_get.md
View file

@ -38,7 +38,7 @@ See https://gohugo.io/hugo-modules/ for more information.
```
hugo mod get [flags]
hugo mod get [flags] [args]
```
### Options
@ -54,7 +54,9 @@ hugo mod get [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

5
content/en/commands/hugo_mod_graph.md
View file

@ -14,12 +14,13 @@ Note that for vendored modules, that is the version listed and not the one from
```
hugo mod graph [flags]
hugo mod graph [flags] [args]
```
### Options
```
--clean delete module cache for dependencies that fail verification
-h, --help help for graph
```
@ -30,7 +31,9 @@ hugo mod graph [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_mod_init.md
View file

@ -19,7 +19,7 @@ inside a subfolder on GitHub, as one example.
```
hugo mod init [flags]
hugo mod init [flags] [args]
```
### Options
@ -35,7 +35,9 @@ hugo mod init [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_mod_npm.md
View file

@ -12,7 +12,7 @@ Various npm helpers.
Various npm (Node package manager) helpers.
```
hugo mod npm [flags]
hugo mod npm [command] [flags]
```
### Options
@ -28,7 +28,9 @@ hugo mod npm [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_mod_npm_pack.md
View file

@ -22,7 +22,7 @@ so this may/will change in future versions of Hugo.
```
hugo mod npm pack [flags]
hugo mod npm pack [flags] [args]
```
### Options
@ -38,7 +38,9 @@ hugo mod npm pack [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

4
content/en/commands/hugo_mod_tidy.md
View file

@ -8,7 +8,7 @@ url: /commands/hugo_mod_tidy/
Remove unused entries in go.mod and go.sum.
```
hugo mod tidy [flags]
hugo mod tidy [flags] [args]
```
### Options
@ -24,7 +24,9 @@ hugo mod tidy [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

5
content/en/commands/hugo_mod_vendor.md
View file

@ -10,12 +10,11 @@ Vendor all module dependencies into the _vendor directory.
### Synopsis
Vendor all module dependencies into the _vendor directory.
If a module is vendored, that is where Hugo will look for it's dependencies.
```
hugo mod vendor [flags]
hugo mod vendor [flags] [args]
```
### Options
@ -31,7 +30,9 @@ hugo mod vendor [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

5
content/en/commands/hugo_mod_verify.md
View file

@ -11,9 +11,8 @@ Verify dependencies.
Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded.
```
hugo mod verify [flags]
hugo mod verify [flags] [args]
```
### Options
@ -30,7 +29,9 @@ hugo mod verify [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

48
content/en/commands/hugo_new.md
View file

@ -19,60 +19,31 @@ If archetypes are provided in your theme or site, they will be used.
Ensure you run this within the root directory of your site.
```
hugo new [path] [flags]
hugo new [command] [flags]
```
### Options
```
-b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disableKinds strings disable different kind of pages (home, RSS etc.)
--editor string edit new content with this editor, if provided
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
-f, --force overwrite file if it already exists
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for new
--ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-k, --kind string content type to create
-l, --layoutDir string filesystem path to layout directory
--minify minify any supported output format (HTML, XML etc.)
--noBuildLock don't create .hugo_build.lock file
--noChmod don't sync permission mode of files
--noTimes don't sync modification time of files
--panicOnWarning panic on first WARNING log
--poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes
--printI18nWarnings print missing translations
--printMemoryUsage print memory usage to screen at intervals
--printPathWarnings print warnings on duplicate target paths etc.
--printUnusedTemplates print warnings on unused templates.
-s, --source string filesystem path to read files relative from
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general)
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
@ -80,6 +51,7 @@ hugo new [path] [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo new content](/commands/hugo_new_content/) - Create new content for your site
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
* [hugo new theme](/commands/hugo_new_theme/) - Create a new site (skeleton)

57
content/en/commands/hugo_new_content.md Normal file
View file

@ -0,0 +1,57 @@
---
title: "hugo new content"
slug: hugo_new_content
url: /commands/hugo_new_content/
---
## hugo new content
Create new content for your site
### Synopsis
Create a new content file and automatically set the date and title.
It will guess which kind of file to create based on the path provided.
You can also specify the kind with `-k KIND`.
If archetypes are provided in your theme or site, they will be used.
Ensure you run this within the root directory of your site.
```
hugo new content [path] [flags]
```
### Options
```
--editor string edit new content with this editor, if provided
-f, --force overwrite file if it already exists
-h, --help help for content
-k, --kind string content type to create
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site

13
content/en/commands/hugo_new_site.md
View file

@ -20,25 +20,26 @@ hugo new site [path] [flags]
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
--force init inside non-empty directory
-f, --format string config file format (default "toml")
-h, --help help for site
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

23
content/en/commands/hugo_new_theme.md
View file

@ -5,39 +5,40 @@ url: /commands/hugo_new_theme/
---
## hugo new theme
Create a new theme
Create a new site (skeleton)
### Synopsis
Create a new theme (skeleton) called [name] in ./themes.
New theme is a skeleton. Please add content to the touched files. Add your
name to the copyright line in the license and adjust the theme.toml file
as you see fit.
Create a new site in the provided directory.
The new site will have the correct structure, but no content or theme yet.
Use `hugo new [contentPath]` to create new content.
```
hugo new theme [name] [flags]
hugo new theme [path] [flags]
```
### Options
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-e, --environment string build environment
-h, --help help for theme
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
```
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

15
content/en/commands/hugo_server.md
View file

@ -23,7 +23,7 @@ and push the latest content to them. As most Hugo sites are built in a fraction
of a second, you will be able to save and see your changes nearly instantly.
```
hugo server [flags]
hugo server [flags] [args]
```
### Options
@ -37,20 +37,16 @@ hugo server [flags]
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
--disableBrowserError do not show build errors in the browser
--disableFastRender enables full re-renders on changes
--disableKinds strings disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild
--enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages
-e, --environment string build environment
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for server
--ignoreCache ignores the cache directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
-l, --layoutDir string filesystem path to layout directory
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
@ -70,11 +66,9 @@ hugo server [flags]
--printUnusedTemplates print warnings on unused templates.
--renderStaticToDisk serve static files from disk and dynamic files from memory
--renderToDisk serve all files from disk (default is from memory)
-s, --source string filesystem path to read files relative from
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme strings themes to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
--trace file write trace to file (not useful in general)
-w, --watch watch filesystem for changes and recreate as needed (default true)
```
@ -82,12 +76,19 @@ hugo server [flags]
### Options inherited from parent commands
```
--clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```

8
content/en/commands/hugo_version.md
View file

@ -5,14 +5,14 @@ url: /commands/hugo_version/
---
## hugo version
Print the version number of Hugo
Print Hugo version and environment info
### Synopsis
All software has versions. This is Hugo's.
Print Hugo version and environment info. This is useful in Hugo bug reports.
```
hugo version [flags]
hugo version [flags] [args]
```
### Options
@ -28,7 +28,9 @@ hugo version [flags]
--config string config file (default is hugo.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-d, --destination string filesystem path to write files to
-e, --environment string build environment
--format string preferred file format (toml, yaml or json) (default "toml")
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)

2
content/en/content-management/cross-references.md
View file

@ -139,7 +139,7 @@ produces this HTML:
## Ref and RelRef Configuration
The behavior can, since Hugo 0.45, be configured in `config.toml`:
The behavior can, since Hugo 0.45, be configured in `hugo.toml`:
refLinksErrorLevel ("ERROR")
: When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this log level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`).

2
content/en/content-management/front-matter.md
View file

@ -135,7 +135,7 @@ weight
: Field name of the *plural* form of the index. See `tags` and `categories` in the above front matter examples. *Note that the plural form of user-defined taxonomies cannot be the same as any of the predefined front matter variables.*
{{% note %}}
If neither `slug` nor `url` is present and [permalinks are not configured otherwise in your site `config` file](/content-management/urls/#permalinks), Hugo will use the filename of your content to create the output URL. See [Content Organization](/content-management/organization) for an explanation of paths in Hugo and [URL Management](/content-management/urls/) for ways to customize Hugo's default behaviors.
If neither `slug` nor `url` is present and [permalinks are not configured otherwise in your site configuration file](/content-management/urls/#permalinks), Hugo will use the filename of your content to create the output URL. See [Content Organization](/content-management/organization) for an explanation of paths in Hugo and [URL Management](/content-management/urls/) for ways to customize Hugo's default behaviors.
{{% /note %}}
### User-Defined

4
content/en/content-management/image-processing/index.md
View file

@ -384,7 +384,7 @@ Note the self-closing shortcode syntax above. You may call the `imgproc` shortco
Define an `imaging` section in your site configuration to set the default [image processing options](#image-processing-options).
{{< code-toggle file="config" copy=true >}}
{{< code-toggle file="hugo" copy=true >}}
[imaging]
resampleFilter = "Box"
quality = 75
@ -412,7 +412,7 @@ resampleFilter
Define an `imaging.exif` section in your site configuration to control the availability of Exif data.
{{< code-toggle file="config" copy=true >}}
{{< code-toggle file="hugo" copy=true >}}
[imaging.exif]
includeFields = ""
excludeFields = ""

8
content/en/content-management/menus.md
View file

@ -36,7 +36,7 @@ Although you can use these methods in combination when defining a menu, the menu
To automatically define menu entries for each top-level section of your site, enable the section pages menu in your site configuration.
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
sectionPagesMenu = "main"
{{< /code-toggle >}}
@ -111,7 +111,7 @@ Access the entry with `site.Menus.main` in your templates. See [menu templates]
To define entries for the "main" menu:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[[menu.main]]
name = 'Home'
pageRef = '/'
@ -132,7 +132,7 @@ This creates a menu structure that you can access with `site.Menus.main` in your
To define entries for the "footer" menu:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[[menu.footer]]
name = 'Terms'
pageRef = '/terms'
@ -177,7 +177,7 @@ url
This nested menu demonstrates some of the available properties:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[[menu.main]]
name = 'Products'
pageRef = '/products'

22
content/en/content-management/multilingual.md
View file

@ -21,7 +21,7 @@ Also See [Hugo Multilingual Part 1: Content translation].
The following is an example of a site configuration for a multilingual Hugo project:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
defaultContentLanguage = "en"
copyright = "Everything is mine"
@ -73,10 +73,10 @@ Only the obvious non-global options can be overridden per language. Examples of
{{< new-in "0.112.0" >}}
In version `0.112.0` of Hugo we did a major we consolidated all configuration options, but also improved how the languages and their params gets merged with the main configuration. But while testing this on Hugo sites out there, we got some error reports.
In Hugo `v0.112.0` we consolidated all configuration options, and improved how the languages and their parameters are merged with the main configuration. But while testing this on Hugo sites out there, we received some error reports and reverted some of the changes in favor of deprecation warnings:
1. `site.Language.Params` is deprecated. Use `site.Params` directly.
1. The `params` sections on site and language is the only place to put custom user parameters, and `site.Params` will only contain these user defined parameters (see example below).
1. Adding custom params to the top level language config is deprecated, add all of these below `[params]`, see `color` in the example below.
```toml
title = "My blog"
@ -90,7 +90,7 @@ languageCode = "sv"
color = "blue"
```
In the example above, all the settings exept the `color` below `params` maps to predefined configuration options in Hguo for the site and its language, and should be accessed via the documented accessors:
In the example above, all settings except `color` below `params` map to predefined configuration options in Hugo for the site and its language, and should be accessed via the documented accessors:
```
{{ site.Title }}
@ -102,7 +102,7 @@ In the example above, all the settings exept the `color` below `params` maps to
You can disable one or more languages. This can be useful when working on a new translation.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
disableLanguages = ["fr", "ja"]
{{< /code-toggle >}}
@ -114,7 +114,7 @@ We kept this as a standalone setting to make it easier to set via [OS environmen
HUGO_DISABLELANGUAGES="fr ja" hugo
```
If you have already a list of disabled languages in `config.toml`, you can enable them in development like this:
If you have already a list of disabled languages in `hugo.toml`, you can enable them in development like this:
```bash
HUGO_DISABLELANGUAGES=" " hugo server
@ -132,7 +132,7 @@ If a `baseURL` is set on the `language` level, then all languages must have one
Example:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[languages]
[languages.fr]
baseURL = "https://example.fr"
@ -194,7 +194,7 @@ If a file has no language code, it will be assigned the default language.
This system uses different content directories for each of the languages. Each language's content directory is set using the `contentDir` param.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
languages:
en:
weight: 10
@ -400,7 +400,7 @@ In case you need to pass a custom data: (`(dict "Count" numeric_value_only)` is
The following localization examples assume your site's primary language is English, with translations to French and German.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
defaultContentLanguage = 'en'
[languages]
@ -522,7 +522,7 @@ The `identifier` depends on how you define menu entries:
For example, if you define menu entries in site configuration:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[[menu.main]]
identifier = 'products'
name = 'Products'
@ -551,7 +551,7 @@ services = 'Leistungen'
For example:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[languages.de]
languageCode = 'de-DE'
languageName = 'Deutsch'

2
content/en/content-management/page-resources.md
View file

@ -78,7 +78,7 @@ MediaType.MainType
: The main type of the resource's MIME type. For example, a file of MIME type `application/pdf` has for MainType `application`.
MediaType.SubType
: The subtype of the resource's MIME type. For example, a file of MIME type `application/pdf` has for SubType `pdf`. Note that this is not the same as the file extension - PowerPoint files have a subtype of `vnd.mspowerpoint`.
: The subtype of the resource's MIME type. For example, a file of MIME type `application/pdf` has for SubType `pdf`. Note that this is not the same as the file extension. For example, Microsoft PowerPoint files (`.ppt`) have a subtype of `vnd.ms-powerpoint`.
MediaType.Suffixes
: A slice of possible suffixes for the resource's MIME type.

4
content/en/content-management/related.md
View file

@ -66,7 +66,7 @@ We improved and simplified this feature in Hugo 0.111.0. Before this we had 3 di
Hugo can index the headings in your content and use this to find related content. You can enable this by adding a index of type `fragments` to your `related` configuration:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[related]
threshold = 20
includeNewer = true
@ -113,7 +113,7 @@ Hugo provides a sensible default configuration of Related Content, but you can f
Without any `related` configuration set on the project, Hugo's Related Content methods will use the following.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
related:
threshold: 80
includeNewer: false

5
content/en/content-management/shortcodes.md
View file

@ -116,6 +116,9 @@ height
width
: `width` attribute of the image.
loading
: `loading` attribute of the image.
attr
: Image attribution text. Markdown within the value of `attr` will be rendered.
@ -222,7 +225,7 @@ You must obtain an Access Token to use the `instagram` shortcode.
If your site configuration is private:
{{< code-toggle file=config copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[services.instagram]
accessToken = 'xxx'
{{< /code-toggle >}}

2
content/en/content-management/static-files.md
View file

@ -28,7 +28,7 @@ This union filesystem will be served from your site root. So a file
Here's an example of setting `staticDir` and `staticDir2` for a
multi-language site:
{{< code-toggle copy=false file="config" >}}
{{< code-toggle copy=false file="hugo" >}}
staticDir = ["static1", "static2"]
[languages]

8
content/en/content-management/taxonomies.md
View file

@ -82,7 +82,7 @@ Hugo natively supports taxonomies.
Without adding a single line to your [site config][config] file, Hugo will automatically create taxonomies for `tags` and `categories`. That would be the same as manually [configuring your taxonomies](#configure-taxonomies) as below:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[taxonomies]
tag = "tags"
category = "categories"
@ -90,7 +90,7 @@ Without adding a single line to your [site config][config] file, Hugo will autom
If you do not want Hugo to create any taxonomies, set `disableKinds` in your [site config][config] to the following:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
disableKinds = ["taxonomy","term"]
{{</ code-toggle >}}
@ -113,7 +113,7 @@ Custom taxonomies other than the [defaults](#default-taxonomies) must be defined
While adding custom taxonomies, you need to put in the default taxonomies too, _if you want to keep them_.
{{% /note %}}
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[taxonomies]
tag = "tags"
category = "categories"
@ -124,7 +124,7 @@ While adding custom taxonomies, you need to put in the default taxonomies too, _
If you want to have just the default `tags` taxonomy, and remove the `categories` taxonomy for your site, you can do so by modifying the `taxonomies` value in your [site config][config].
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[taxonomies]
tag = "tags"
{{</ code-toggle >}}

14
content/en/content-management/urls.md
View file

@ -110,7 +110,7 @@ content/
Create a date-based hierarchy, recursively, for regular pages within the `posts` section:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[permalinks]
posts = '/posts/:year/:month/:title/'
{{< /code-toggle >}}
@ -133,7 +133,7 @@ public/
To create a date-based hierarchy for regular pages in the content root:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[permalinks]
'/' = '/:year/:month/:title/'
{{< /code-toggle >}}
@ -144,7 +144,7 @@ A URL pattern defined for the content root is not recursive.
Use the same approach with taxonomies. For example, to omit the taxonomy segment of the URL:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[permalinks]
'tags' = '/:title/'
{{< /code-toggle >}}
@ -198,7 +198,7 @@ For time-related values, you can also use the layout string components defined i
[time package]: https://pkg.go.dev/time#pkg-constants
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
permalinks:
posts: /:06/:1/:2/:title/
{{< /code-toggle >}}
@ -214,7 +214,7 @@ pretty|content/about.md|`https://example.org/about/`
By default, Hugo produces pretty URLs. To generate ugly URLs, change your site configuration:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
uglyURLs = true
{{< /code-toggle >}}
@ -241,7 +241,7 @@ This is an imperfect, brute force approach that can affect content as well as HT
To enable:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
canonifyURLs = true
{{< /code-toggle >}}
@ -264,7 +264,7 @@ This is an imperfect, brute force approach that can affect content as well as HT
To enable:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
relativeURLs = true
{{< /code-toggle >}}

4
content/en/contribute/documentation.md
View file

@ -128,7 +128,7 @@ fm
#### Site configuration example
```text
{{</* code-toggle file="config" */>}}
{{</* code-toggle file="hugo" */>}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"
@ -137,7 +137,7 @@ title = "Example Site"
Rendered:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"

21
content/en/functions/hasPrefix.md Normal file
View file

@ -0,0 +1,21 @@
---
title: hasprefix
linktitle: hasPrefix
description: Tests whether a string begins with prefix.
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
categories: [functions]
menu:
docs:
parent: "functions"
keywords: [strings]
signature: ["hasPrefix STRING PREFIX"]
workson: []
hugoversion:
relatedfuncs: [hasSuffix]
deprecated: false
aliases: []
---
* `{{ hasPrefix "Hugo" "Hu" }}` → true

21
content/en/functions/hasSuffix.md Normal file
View file

@ -0,0 +1,21 @@
---
title: hassuffix
linktitle: hasSuffix
description: Tests whether a string ends with suffix.
date: 2023-03-01
publishdate: 2023-03-01
lastmod: 2023-03-01
categories: [functions]
menu:
docs:
parent: "functions"
keywords: [strings]
signature: ["hasSuffix STRING SUFFIX"]
workson: []
hugoversion:
relatedfuncs: [hasPrefix]
deprecated: false
aliases: []
---
* `{{ hasSuffix "Hugo" "go" }}` → true

69
content/en/functions/hugo.md
View file

@ -13,32 +13,35 @@ relatedfuncs: []
`hugo` returns an instance that contains the following functions:
hugo.Generator
: `<meta>` tag for the version of Hugo that generated the site. `hugo.Generator` outputs a *complete* HTML tag; e.g. `<meta name="generator" content="Hugo 0.63.2">`
`hugo.BuildDate`
: (`string`) The compile date of the current Hugo binary formatted per [RFC&nbsp;3339](https://datatracker.ietf.org/doc/html/rfc3339) (e.g., `2023-05-23T08:14:20Z`).
hugo.Version
: the current version of the Hugo binary you are using e.g. `0.99.1`
`hugo.CommitHash`
: (`string`) The Git commit hash of the Hugo binary (e.g., `0a95d6704a8ac8d41cc5ca8fffaad8c5c7a3754a`).
hugo.GoVersion
: returns the version of Go that the Hugo binary was built with. {{< new-in "0.101.0" >}}
`hugo.Deps`
: (`[]*hugo.Dependency`) See [hugo.Deps](#hugodeps).
hugo.Environment
: the current running environment as defined through the `--environment` cli tag
`hugo.Environment`
: (`string`) The current running environment as defined through the `--environment` CLI flag (e.g., `development`, `production`).
hugo.CommitHash
: the git commit hash of the current Hugo binary e.g. `0e8bed9ccffba0df554728b46c5bbf6d78ae5247`
`hugo.Generator`
: (`template.HTML`) Renders an HTML `meta` element identifying the software that generated the site (e.g., `<meta name="generator" content="Hugo 0.112.0">`).
hugo.BuildDate
: the compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00`
`hugo.GoVersion`
: (`string`) The Go version used to compile the Hugo binary (e.g., `go1.20.4`). {{< new-in "0.101.0" >}}
hugo.IsExtended
: whether this is the extended Hugo binary.
`hugo.IsExtended`
: (`bool`) Returns `true` if the Hugo binary is the extended version.
hugo.IsProduction
: returns true if `hugo.Environment` is set to the production environment
`hugo.IsProduction`
: (`bool`) Returns `true` if `hugo.Environment` is set to the production environment.
hugo.Deps
: See [hugo.Deps](#hugodeps)
`hugo.Version`
: (`hugo.VersionString`) The current version of the Hugo binary (e.g., `0.112.1`).
`hugo.WorkingDir`
: (`string`) The project working directory (e.g., `/home/user/projects/my-hugo-site`). {{< new-in "0.112.0" >}}
## hugo.Deps
@ -48,23 +51,23 @@ hugo.Deps
Each dependency contains:
Path (string)
: Returns the path to this module. This will either be the module path, e.g. "github.com/gohugoio/myshortcodes", or the path below your /theme folder, e.g. "mytheme".
Version (string)
: The module version.
Vendor (bool)
: Whether this dependency is vendored.
Time (time.Time)
: Time version was created.
Owner
: In the dependency tree, this is the first module that defines this module as a dependency.
: (`*hugo.Dependency`) In the dependency tree, this is the first module that defines this module as a dependency (e.g., `github.com/gohugoio/hugo-mod-bootstrap-scss/v5`).
Replace (*Dependency)
: Replaced by this dependency.
Path
: (`string`) The module path or the path below your `themes` directory (e.g., `github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2`).
Replace
: (`*hugo.Dependency`) Replaced by this dependency.
Time
: (`time.Time`) The time that the version was created (e.g., `2022-02-13 15:11:28 +0000 UTC`).
Vendor
: (`bool`) Returns `true` if the dependency is vendored.
Version
: (`string`) The module version (e.g., `v2.21100.20000`).
An example table listing the dependencies:

1
content/en/functions/math.md
View file

@ -23,6 +23,7 @@ relatedfuncs: []
| | *If one of the numbers is a float, the result is a float.* | `{{ div 6 4.0 }}` &rarr; `1.5` |
| `mod` | Modulus of two integers. | `{{ mod 15 3 }}` &rarr; `0` |
| `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{ modBool 15 3 }}` &rarr; `true` |
| `math.Abs` | Returns the absolute value of the given number. | `{{ math.Abs -2.1 }}` &rarr; `2.1` |
| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{ math.Ceil 2.1 }}` &rarr; `3` |
| `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{ math.Floor 1.9 }}` &rarr; `1` |
| `math.Log` | Returns the natural logarithm of the given number. | `{{ math.Log 42 }}` &rarr; `3.737` |

2
content/en/functions/param.md
View file

@ -17,7 +17,7 @@ For example, to show a table of contents on every page, but allow authors to hid
**Configuration**
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[params]
display_toc = true
{{< /code-toggle >}}

4
content/en/functions/safeHTML.md
View file

@ -12,9 +12,9 @@ relatedfuncs: []
It should not be used for HTML from a third-party, or HTML with unclosed tags or comments.
Given a site-wide [`config.toml`][config] with the following `copyright` value:
Given a site-wide [`hugo.toml`][config] with the following `copyright` value:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
copyright = "© 2015 Jane Doe. <a href=\"https://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>."
{{< /code-toggle >}}

2
content/en/functions/safeHTMLAttr.md
View file

@ -12,7 +12,7 @@ relatedfuncs: []
Given a site configuration that contains this menu entry:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[[menu.main]]
name = "IRC"
url = "irc://irc.freenode.net/#golang"

4
content/en/functions/safeURL.md
View file

@ -14,9 +14,9 @@ relatedfuncs: []
Without `safeURL`, only the URI schemes `http:`, `https:` and `mailto:` are considered safe by Go templates. If any other URI schemes (e.g., `irc:` and `javascript:`) are detected, the whole URL will be replaced with `#ZgotmplZ`. This is to "defang" any potential attack in the URL by rendering it useless.
The following examples use a [site `config.toml`][configuration] with the following [menu entry][menus]:
The following examples use a [site `hugo.toml`][configuration] with the following [menu entry][menus]:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[[menu.main]]
name = "IRC: #golang at freenode"
url = "irc://irc.freenode.net/#golang"

4
content/en/functions/sort.md
View file

@ -18,7 +18,7 @@ The `ORDER` may be either `asc` (ascending) or `desc` (descending). The default
The examples below assume this site configuration:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[params]
grades = ['b','a','c']
{{< /code-toggle >}}
@ -48,7 +48,7 @@ In the example above, `value` is the `KEY` representing the value of the slice e
The examples below assume this site configuration:
{{< code-toggle file="config" copy=false >}}
{{< code-toggle file="hugo" copy=false >}}
[params.authors.a]
firstName = "Marius"
lastName = "Pontmercy"

25
content/en/functions/urls.JoinPath.md Normal file
View file

@ -0,0 +1,25 @@
---
title: urls.JoinPath
description: Joins the provided elements into a URL string and cleans the result of any ./ or ../ elements. If the argument list is empty, JoinPath returns an empty string.
categories: [functions]
menu:
docs:
parent: functions
keywords: [urls,path,join]
signature: ["urls.JoinPath ELEMENT..."]
---
```go-html-template
{{ urls.JoinPath }} → ""
{{ urls.JoinPath "" }} → "/"
{{ urls.JoinPath "a" }} → "a"
{{ urls.JoinPath "a" "b" }} → "a/b"
{{ urls.JoinPath "/a" "b" }} → "/a/b"
{{ urls.JoinPath "https://example.org" "b" }} → "https://example.org/b"
{{ urls.JoinPath (slice "a" "b") }} → "a/b"
```
Unlike the [`path.Join`] function, `urls.JoinPath` retains consecutive leading slashes.
[`path.Join`]: /functions/path.join/

2
content/en/functions/where.md
View file

@ -158,7 +158,7 @@ will default to the *section with the most pages*.
The user can override the default:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[params]
mainSections = ["blog", "docs"]
{{< /code-toggle >}}

58
content/en/getting-started/configuration.md
View file

@ -15,8 +15,8 @@ toc: true
## Configuration File
Hugo uses the `config.toml`, `config.yaml`, or `config.json` (if found in the
site root) as the default site config file.
Hugo uses the `hugo.toml`, `hugo.yaml`, or `hugo.json` (if found in the
site root) as the default site configuration file.
The user can choose to override that default with one or more site config files
using the command-line `--config` switch.
@ -45,7 +45,7 @@ In addition to using a single site config file, one can use the `configDir` dire
- Each file represents a configuration root object, such as `params.toml` for `[Params]`, `menu(s).toml` for `[Menu]`, `languages.toml` for `[Languages]` etc...
- Each file's content must be top-level, for example:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[Params]
foo = "bar"
{{< /code-toggle >}}
@ -61,35 +61,35 @@ foo = "bar"
```txt
├── config
│ ├── _default
│ │ ├── config.toml
│ │ ├── hugo.toml
│ │ ├── languages.toml
│ │ ├── menus.en.toml
│ │ ├── menus.zh.toml
│ │ └── params.toml
│ ├── production
│ │ ├── config.toml
│ │ ├── hugo.toml
│ │ └── params.toml
│ └── staging
│ ├── config.toml
│ ├── 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 `googleAnalytics = "G-XXXXXXXX"` in `config.toml`. Now consider the following scenario:
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 `hugo.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 server`. This works since, by default Hugo sets `Environment=development` when you run `hugo server` which uses the config files from `_default` folder
2. In `production/config.toml` you just need to have one line:
This is how you need to configure your `hugo.toml` files considering the above scenario:
1. In `_default/hugo.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 server`. This works since, by default Hugo sets `Environment=development` when you run `hugo server` which uses the config files from `_default` folder
2. In `production/hugo.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:
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/hugo.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/hugo.toml` you just need to have one line:
```googleAnalytics = "G-SSSSSSSS"```
@ -378,7 +378,7 @@ The directory to where Hugo will write the final static site (the HTML files etc
### related
: See [Related Content](/content-management/related/#configure-related-content).
See [Related Content](/content-management/related/#configure-related-content).
### relativeURLs
@ -494,7 +494,7 @@ enableemoji: true
The `build` configuration section contains global build-related configuration options.
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[build]
useResourceCacheWhen="fallback"
writeStats = false
@ -518,7 +518,7 @@ noJSConfigInAssets
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](https://docs.netlify.com/routing/headers/#syntax-for-the-netlify-configuration-file) with slightly more powerful [Glob matching](https://github.com/gobwas/glob):
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[server]
[[server.headers]]
for = "/**"
@ -592,18 +592,18 @@ HUGO_NUMWORKERMULTIPLIER
Similar to the template [lookup order], Hugo has a default set of rules for searching for a configuration file in the root of your website's source directory as a default behavior:
1. `./config.toml`
2. `./config.yaml`
3. `./config.json`
1. `./hugo.toml`
2. `./hugo.yaml`
3. `./hugo.json`
In your `config` file, you can direct Hugo as to how you want your website rendered, control your website's menus, and arbitrarily define site-wide parameters specific to your project.
In your configuration file, you can direct Hugo as to how you want your website rendered, control your website's menus, and arbitrarily define site-wide parameters specific to your project.
## Example Configuration
The following is a typical example of a configuration file. The values nested under `params:` will populate the [`.Site.Params`] variable for use in [templates]:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
baseURL: "https://yoursite.example.com/"
title: "My Hugo Site"
permalinks:
@ -650,13 +650,13 @@ To exclude specific files from the `content`, `data`, and `i18n` directories whe
To ignore files ending with `.foo` or `.boo`:
{{< code-toggle copy=false >}}
{{< code-toggle copy=false file="hugo" >}}
ignoreFiles = ['\.foo$', '\.boo$']
{{< /code-toggle >}}
To ignore a file using the absolute file path:
{{< code-toggle copy=false >}}
{{< code-toggle copy=false file="hugo" >}}
ignoreFiles = ['^/home/user/project/content/test\.md$']
{{< /code-toggle >}}
@ -664,11 +664,11 @@ ignoreFiles = ['^/home/user/project/content/test\.md$']
### 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 `config.toml`.
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:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[frontmatter]
date = ["date", "publishDate", "lastmod"]
lastmod = [":git", "lastmod", "date", "publishDate"]
@ -678,7 +678,7 @@ expiryDate = ["expiryDate"]
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="config" >}}
{{< code-toggle file="hugo" >}}
[frontmatter]
date = ["myDate", ":default"]
{{< /code-toggle >}}
@ -695,7 +695,7 @@ The special date handlers are:
An example:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[frontmatter]
lastmod = ["lastmod", ":fileModTime", ":default"]
{{< /code-toggle >}}
@ -709,7 +709,7 @@ The above will try first to extract the value for `.Lastmod` starting with the `
An example:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[frontmatter]
date = [":filename", ":default"]
{{< /code-toggle >}}
@ -734,7 +734,7 @@ Default configuration:
Since Hugo 0.52 you can configure more than just the `cacheDir`. This is the default configuration:
{{< code-toggle >}}
{{< code-toggle file="hugo" >}}
[caches]
[caches.getjson]
dir = ":cacheDir/:project"
@ -756,7 +756,7 @@ dir = ":cacheDir/modules"
maxAge = -1
{{< /code-toggle >}}
You can override any of these cache settings in your own `config.toml`.
You can override any of these cache settings in your own `hugo.toml`.
### The keywords explained

4
content/en/getting-started/directory-structure.md
View file

@ -29,7 +29,7 @@ example/
├── public/
├── static/
├── themes/
└── config.toml
└── hugo.toml
```
## Directory Structure Explained
@ -46,7 +46,7 @@ By default, Hugo will create new content files with at least `date`, `title` (in
[`config`](/getting-started/configuration/)
: Hugo ships with a large number of [configuration directives].
The [config directory](/getting-started/configuration/#configuration-directory) is where those directives are stored as JSON, YAML, or TOML files. Every root setting object can stand as its own file and structured by environments.
Projects with minimal settings and no need for environment awareness can use a single `config.toml` file at its root.
Projects with minimal settings and no need for environment awareness can use a single `hugo.toml` file at its root.
Many sites may need little to no configuration, but Hugo ships with a large number of [configuration directives] for more granular directions on how you want Hugo to build your website. Note: config directory is not created by default.

8
content/en/getting-started/quick-start.md
View file

@ -23,7 +23,7 @@ In this tutorial you will:
Before you begin this tutorial you must:
1. [Install Hugo] (the extended edition)
1. [Install Hugo] (extended edition, v0.112.0 or later)
1. [Install Git]
You must also be comfortable working from the command line.
@ -51,7 +51,7 @@ hugo new site quickstart
cd quickstart
git init
git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke
echo "theme = 'ananke'" >> config.toml
echo "theme = 'ananke'" >> hugo.toml
hugo server
```
@ -86,7 +86,7 @@ git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/an
Append a line to the site configuration file, indicating the current theme.
```text
echo "theme = 'ananke'" >> config.toml
echo "theme = 'ananke'" >> hugo.toml
```
Start Hugo's development server to view the site.
@ -152,7 +152,7 @@ Hugo's rendering engine conforms to the CommonMark [specification] for markdown.
## Configure the site
With your editor, open the [site configuration] file (`config.toml`) in the root of your project.
With your editor, open the [site configuration] file (`hugo.toml`) in the root of your project.
```text
baseURL = 'http://example.org/'

12
content/en/hugo-modules/configuration.md
View file

@ -13,7 +13,7 @@ toc: true
## Module Config: Top level
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[module]
noVendor = ""
proxy = "direct"
@ -56,7 +56,7 @@ env HUGO_MODULE_PROXY=https://proxy.example.org hugo
If your module requires a particular version of Hugo to work, you can indicate that in the `module` section and the user will be warned if using a too old/new version.
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[module]
[module.hugoVersion]
min = ""
@ -78,7 +78,7 @@ extended
## Module Config: imports
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[module]
[[module.imports]]
path = "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v"
@ -93,7 +93,7 @@ path
: Can be either a valid Go Module module path, e.g. `github.com/gohugoio/myShortcodes`, or the directory name for the module as stored in your themes folder.
ignoreConfig
: If enabled, any module configuration file, e.g. `config.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies.
: If enabled, any module configuration file, e.g. `hugo.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies.
ignoreImports
: If enabled, module imports will not be followed.
@ -120,7 +120,7 @@ When you add a mount, the default mount for the concerned target root is ignored
{{% /note %}}
**Default mounts**
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[module]
[[module.mounts]]
source="content"
@ -165,7 +165,7 @@ excludeFiles (string or slice)
: One or more glob patterns matching files to exclude.
**Example**
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
[module]
[[module.mounts]]
source="content"

8
content/en/hugo-modules/theme-components.md
View file

@ -17,13 +17,13 @@ This section contain information that may be outdated and is in the process of b
{{% /note %}}
Since Hugo `0.42` a project can configure a theme as a composite of as many theme components you need:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
theme = ["my-shortcodes", "base-theme", "hyde"]
{{< /code-toggle >}}
You can even nest this, and have the theme component itself include theme components in its own `config.toml` (theme inheritance).[^1]
You can even nest this, and have the theme component itself include theme components in its own `hugo.toml` (theme inheritance).[^1]
The theme definition example above in `config.toml` creates a theme with 3 theme components with precedence from left to right.
The theme definition example above in `hugo.toml` creates a theme with 3 theme components with precedence from left to right.
For any given file, data entry, etc., Hugo will look first in the project and then in `my-shortcodes`, `base-theme`, and lastly `hyde`.
@ -34,7 +34,7 @@ Hugo uses two different algorithms to merge the filesystems, depending on the fi
The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically.
Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure:
Also note that a component that is part of a theme can have its own configuration file, e.g. `hugo.toml`. There are currently some restrictions to what a theme component can configure:
* `params` (global and per language)
* `menu` (global and per language)

2
content/en/hugo-modules/use-modules.md
View file

@ -33,7 +33,7 @@ The easiest way to use a Module for a theme is to import it in the config.
1. Initialize the hugo module system: `hugo mod init github.com/<your_user>/<your_project>`
2. Import the theme:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[module]
[[module.imports]]
path = "github.com/spf13/hyde"

13
content/en/hugo-pipes/introduction.md
View file

@ -124,10 +124,19 @@ Remote resources fetched with `resources.GetRemote` will be cached on disk. See
`resources.Copy` allows you to copy almost any Hugo `Resource` (the one exception is the `Page`), possibly most useful for renaming things:
```go-html-template
{{ $resized := $image.Resize "400x400" | resources.Copy "images/mynewname.jpg" }}
<img src="{{ $resized.RelPermalink }}">
{{ with resources.Get "img/a.jpg" }}
{{ with .Resize "300x" }}
{{ with resources.Copy "img/a-new.jpg" . }}
<img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}
{{ end }}
{{ end }}
```
{{% note %}}
The target path must be different than the source path, as shown in the example above. See GitHub issue [#10412](https://github.com/gohugoio/hugo/issues/10412).
{{% /note %}}
## Asset directory
Asset files must be stored in the asset directory. This is `/assets` by default, but can be configured via the configuration file's `assetDir` key.

2
content/en/hugo-pipes/postprocess.md
View file

@ -36,7 +36,7 @@ There are several ways to set up CSS purging with PostCSS in Hugo. If you have a
The below configuration will write a `hugo_stats.json` file to the project root as part of the build. If you're only using this for the production build, you should consider placing it below [config/production](/getting-started/configuration/#configuration-directory).
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[build]
writeStats = true
{{< /code-toggle >}}

12
content/en/templates/internal.md
View file

@ -31,12 +31,12 @@ Hugo ships with internal templates supporting Google Analytics, both [Google Ana
Provide your tracking ID in your configuration file:
**Google Analytics 4 (gtag.js)**
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
googleAnalytics = "G-MEASUREMENT_ID"
{{</ code-toggle >}}
**Google Universal Analytics (analytics.js)**
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
googleAnalytics = "UA-PROPERTY_ID"
{{</ code-toggle >}}
@ -64,7 +64,7 @@ Hugo also ships with an internal template for [Disqus comments][disqus], a popul
To use Hugo's Disqus template, you first need to set a single configuration value:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
disqusShortname = "your-disqus-shortname"
{{</ code-toggle >}}
@ -127,7 +127,7 @@ This format is used for Facebook and some other sites.
Hugo's Open Graph template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[params]
title = "My cool site"
images = ["site-feature-image.jpg"]
@ -177,7 +177,7 @@ metadata used to attach rich media to Tweets linking to your site.
Hugo's Twitter Card template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[params]
images = ["site-feature-image.jpg"]
description = "Text about my cool site"
@ -197,7 +197,7 @@ Hugo uses the page title and description for the card's title and description fi
The `.Site.Social.twitter` variable is exposed from the config as the value for `twitter:site`.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[social]
twitter = "GoHugoIO"
{{</ code-toggle >}}

2
content/en/templates/introduction.md
View file

@ -562,7 +562,7 @@ You can arbitrarily define as many site-level parameters as you want in your [si
For instance, you might declare the following:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
params:
copyrighthtml: "Copyright &#xA9; 2017 John Doe. All Rights Reserved."
twitteruser: "spf13"

8
content/en/templates/output-formats.md
View file

@ -31,7 +31,7 @@ This is the full set of built-in media types in Hugo:
To add or modify a media type, define it in a `mediaTypes` section in your [site configuration][config], either for all sites or for a given language.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[mediaTypes]
[mediaTypes."text/enriched"]
suffixes = ["enr"]
@ -43,7 +43,7 @@ The above example adds one new media type, `text/enriched`, and changes the suff
**Note:** these media types are configured for **your output formats**. If you want to redefine one of Hugo's default output formats (e.g. `HTML`), you also need to redefine the media type. So, if you want to change the suffix of the `HTML` output format from `html` (default) to `htm`:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[mediaTypes]
[mediaTypes."text/html"]
suffixes = ["htm"]
@ -70,7 +70,7 @@ This is the full set of Hugo's built-in output formats:
To add or modify an output format, define it in an `outputFormats` section in your site's [configuration file](/getting-started/configuration/), either for all sites or for a given language.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[outputFormats.MyEnrichedFormat]
mediaType = "text/enriched"
baseName = "myindex"
@ -146,7 +146,7 @@ per language).
Example from site config file:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[outputs]
home = ["HTML", "AMP", "RSS"]
page = ["HTML"]

2
content/en/templates/robots.md
View file

@ -14,7 +14,7 @@ aliases: [/extras/robots-txt/]
To generate a robots.txt file from a template, change the [site configuration][config]:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
enableRobotsTXT = true
{{< /code-toggle >}}

4
content/en/templates/rss.md
View file

@ -35,11 +35,11 @@ The table below shows the RSS template lookup order for the different page kinds
## Configure RSS
By default, Hugo will create an unlimited number of RSS entries. You can limit the number of articles included in the built-in RSS templates by assigning a numeric value to `rssLimit:` field in your project's [`config` file][config].
By default, Hugo will create an unlimited number of RSS entries. You can limit the number of articles included in the built-in RSS templates by assigning a numeric value to `rssLimit:` field in your project's configuration file.
The following values will also be included in the RSS output if specified:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
languageCode = "en-us"
copyright = "This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License."

2
content/en/templates/shortcode-templates.md
View file

@ -368,7 +368,7 @@ You can also implement your shortcodes inline -- e.g. where you use them in the
This feature is disabled by default, but can be enabled in your site config:
{{< code-toggle file="config">}}
{{< code-toggle file="hugo" >}}
enableInlineShortcodes = true
{{< /code-toggle >}}

4
content/en/templates/sitemap-template.md
View file

@ -27,7 +27,7 @@ With a multilingual project, Hugo generates:
Set the default values for [change frequency] and [priority], and the name of the generated file, in your site configuration.
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
[sitemap]
changefreq = 'monthly'
filename = 'sitemap.xml'
@ -72,7 +72,7 @@ To override the built-in sitemapindex.xml template, create a new file in either
You may disable sitemap generation in your site configuration:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
disableKinds = ['sitemap']
{{</ code-toggle >}}

4
content/en/variables/page.md
View file

@ -76,7 +76,7 @@ The following is a list of page-level variables. Many of these will be defined i
: the page's *kind*. Possible return values are `page`, `home`, `section`, `taxonomy`, or `term`. Note that there are also `RSS`, `sitemap`, `robotsTXT`, and `404` kinds, but these are only available during the rendering of each of these respective page's kind and therefore *not* available in any of the `Pages` collections.
.Language
: a language object that points to the language's definition in the site `config`. `.Language.Lang` gives you the language code.
: a language object that points to the language's definition in the site configuration. `.Language.Lang` gives you the language code.
.Lastmod
: the date the content was last modified. `.Lastmod` pulls from the `lastmod` field in a content's front matter.
@ -298,7 +298,7 @@ In Hugo, you can declare params in individual pages and globally for your entire
{{ $.Param "header_image" }}
```
The `.Param` method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your `config`).
The `.Param` method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your site configuration).
### Access Nested Fields in Front Matter

2
content/en/variables/site.md
View file

@ -100,7 +100,7 @@ All the methods below, e.g. `.Site.RegularPages` can also be reached via the glo
The following `config.[yaml|toml|json]` defines a site-wide param for `description`:
{{< code-toggle file="config" >}}
{{< code-toggle file="hugo" >}}
baseURL = "https://yoursite.example.com/"
[params]

510
data/docs.json
View file

File diff suppressed because it is too large Load diff

2
go.mod
View file

@ -2,4 +2,4 @@ module github.com/gohugoio/hugoDocs
go 1.16
require github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11 // indirect
require github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a // indirect

2
go.sum
View file

@ -63,3 +63,5 @@ github.com/gohugoio/gohugoioTheme v0.0.0-20230330081257-7a8c9614432c h1:TyHgmowf
github.com/gohugoio/gohugoioTheme v0.0.0-20230330081257-7a8c9614432c/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM=
github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11 h1:mDcricMewd66x8QjKqNun7Div7iYVLtl8s1dVs9VnB8=
github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM=
github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a h1:ruyA3QZ4Ym0fBLhTW2eoUSvHUaj2xWqaPHIbaI+tbZo=
github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM=

2
layouts/shortcodes/code-toggle.html
View file

@ -44,7 +44,7 @@ Renders syntax-highlighted configuration data in JSON, TOML, and YAML formats.
{{- /* Render. */}}
{{- $code := "" }}
{{- with $config }}
{{- $file = $file | default "config" }}
{{- $file = $file | default "hugo" }}
{{- $sections := (split . ".") }}
{{- $configSection := index $.Site.Data.docs.config $sections }}
{{- $code = dict $sections $configSection }}

9
layouts/shortcodes/new-in.html
View file

@ -3,6 +3,11 @@
{{ errorf "Missing version in new-in shortcode " }}
{{ end }}
{{ $version = $version | strings.TrimPrefix "v" }}
<button class="bg-white hover:bg-gray-100 text-gray-800 font-semibold py-2 mr2 ml2 px-4 border border-gray-400 rounded shadow">
<a href="{{ printf "https://github.com/gohugoio/hugo/releases/tag/v%s" $version }}" target="_blank">New in v{{$version}}</a>
<button
class="bg-white hover:bg-gray-100 text-gray-800 font-semibold py-2 mr2 ml2 px-4 border border-gray-400 rounded shadow">
<a
href="{{ printf "https://github.com/gohugoio/hugo/releases/tag/v%s" $version }}"
target="_blank"
>New in v{{ $version }}</a
>
</button>

8
netlify.toml
View file

@ -3,7 +3,7 @@ publish = "public"
command = "hugo --gc --minify"
[context.production.environment]
HUGO_VERSION = "0.111.3"
HUGO_VERSION = "0.112.3"
HUGO_ENV = "production"
HUGO_ENABLEGITINFO = "true"
@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true"
command = "hugo --gc --minify --enableGitInfo"
[context.split1.environment]
HUGO_VERSION = "0.111.3"
HUGO_VERSION = "0.112.3"
HUGO_ENV = "production"
[context.deploy-preview]
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
[context.deploy-preview.environment]
HUGO_VERSION = "0.111.3"
HUGO_VERSION = "0.112.3"
[context.branch-deploy]
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
[context.branch-deploy.environment]
HUGO_VERSION = "0.111.3"
HUGO_VERSION = "0.112.3"
[context.next.environment]
HUGO_ENABLEGITINFO = "true"