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
-# github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11
+# github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a
## 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
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
**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
**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
--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
* [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
--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)
--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)
--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)
--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)
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:
--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)
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
+ -h, --help help for config
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
Print the configured file mounts
```
-hugo config mounts [flags]
+hugo config mounts [flags] [args]
```
### Options
--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)
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
+ -h, --help help for convert
+ -o, --output string filesystem path to write files to
+ --unsafe enable less safe operations, please backup first
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
to use JSON for the front matter.
```
-hugo convert toJSON [flags]
+hugo convert toJSON [flags] [args]
```
### Options
--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)
to use TOML for the front matter.
```
-hugo convert toTOML [flags]
+hugo convert toTOML [flags] [args]
```
### Options
--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)
to use YAML for the front matter.
```
-hugo convert toYAML [flags]
+hugo convert toYAML [flags] [args]
```
### Options
--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)
```
-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
+ --confirm ask for confirmation before making changes to the target
+ --dryRun dry run
+ --force force upload of all files
+ -h, --help help for deploy
+ --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)
+ --target string target deployment from deployments section in config file; defaults to the first one
+ --workers int number of workers to transfer files. defaults to 10 (default 10)
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
### 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
--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)
A collection of several useful generators.
+```
+hugo gen [command] [flags]
+```
+
### Options
```
--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)
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
--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)
### 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/.
-
-It creates one Markdown file per command with front matter suitable
-for rendering in Hugo.
+ This command is, mostly, used to create up-to-date documentation
+ of Hugo's command-line interface for https://gohugo.io/.
+
+ 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
--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)
### Synopsis
This command automatically generates up-to-date man pages of Hugo's
-command-line interface. By default, it creates the man page files
-in the "man" directory under the current directory.
+ 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
--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)
Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`.
+```
+hugo import [command] [flags]
+```
+
### Options
```
--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)
### Synopsis
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
--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)
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
+ -h, --help help for list
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
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
--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)
List all of the drafts in your content directory.
```
-hugo list drafts [flags]
+hugo list drafts [flags] [args]
```
### Options
--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)
List all of the posts in your content directory which has already expired.
```
-hugo list expired [flags]
+hugo list expired [flags] [args]
```
### Options
--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)
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
--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)
### 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".
### 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
+ -h, --help help for mod
+```
+
+### Options inherited from parent commands
+
+```
--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
+ --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
- --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
+ --format string preferred file format (toml, yaml or json) (default "toml")
--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.
+ --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
- --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
-
-```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ -v, --verbose verbose output
+ --verboseLog verbose logging
```
### SEE ALSO
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
--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)
```
-hugo mod get [flags]
+hugo mod get [flags] [args]
```
### Options
--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)
```
-hugo mod graph [flags]
+hugo mod graph [flags] [args]
```
### Options
```
- -h, --help help for graph
+ --clean delete module cache for dependencies that fail verification
+ -h, --help help for graph
```
### Options inherited from parent commands
--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)
### Synopsis
Initialize this project as a Hugo Module.
-It will try to guess the module path, but you may help by passing it as an argument, e.g:
-
- hugo mod init github.com/gohugoio/testshortcodes
-
-Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
-inside a subfolder on GitHub, as one example.
-
+ It will try to guess the module path, but you may help by passing it as an argument, e.g:
+
+ hugo mod init github.com/gohugoio/testshortcodes
+
+ Note that Hugo Modules supports multi-module projects, so you can initialize a Hugo Module
+ inside a subfolder on GitHub, as one example.
+
```
-hugo mod init [flags]
+hugo mod init [flags] [args]
```
### Options
--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)
Various npm (Node package manager) helpers.
```
-hugo mod npm [flags]
+hugo mod npm [command] [flags]
```
### Options
--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)
```
-hugo mod npm pack [flags]
+hugo mod npm pack [flags] [args]
```
### Options
--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)
Remove unused entries in go.mod and go.sum.
```
-hugo mod tidy [flags]
+hugo mod tidy [flags] [args]
```
### Options
--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)
### Synopsis
Vendor all module dependencies into the _vendor directory.
-
-If a module is vendored, that is where Hugo will look for it's dependencies.
-
+ 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
--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)
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
--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)
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
+ -h, --help help for new
+```
+
+### Options inherited from parent commands
+
+```
--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
+ --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
- --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
+ --format string preferred file format (toml, yaml or json) (default "toml")
--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.
+ --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
- --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
-
-```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ -v, --verbose verbose output
+ --verboseLog verbose logging
```
### 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)
--- /dev/null
+---
+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
+
### 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
+ --force init inside non-empty directory
+ -h, --help help for site
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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 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
+ -h, --help help for theme
```
### Options inherited from parent commands
```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ --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
of a second, you will be able to save and see your changes nearly instantly.
```
-hugo server [flags]
+hugo server [flags] [args]
```
### Options
```
- --appendPort append port to baseURL (default true)
- -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
- --bind string interface to which the server will bind (default "127.0.0.1")
- -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
+ --appendPort append port to baseURL (default true)
+ -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/
+ --bind string interface to which the server will bind (default "127.0.0.1")
+ -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
+ -c, --contentDir string filesystem path to content directory
+ --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
+ --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
+ -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")
+ --memstats string log memory usage to this file
+ --minify minify any supported output format (HTML, XML etc.)
+ --navigateToChanged navigate to changed content file on live browser reload
+ --noBuildLock don't create .hugo_build.lock file
+ --noChmod don't sync permission mode of files
+ --noHTTPCache prevent HTTP caching
+ --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
+ -p, --port int port on which the server will listen (default 1313)
+ --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.
+ --renderStaticToDisk serve static files from disk and dynamic files from memory
+ --renderToDisk serve all files from disk (default is from memory)
+ --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/)
+ --trace file write trace to file (not useful in general)
+ -w, --watch watch filesystem for changes and recreate as needed (default true)
+```
+
+### Options inherited from parent commands
+
+```
--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
+ --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
- --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
+ --format string preferred file format (toml, yaml or json) (default "toml")
--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")
- --memstats string log memory usage to this file
- --minify minify any supported output format (HTML, XML etc.)
- --navigateToChanged navigate to changed content file on live browser reload
- --noBuildLock don't create .hugo_build.lock file
- --noChmod don't sync permission mode of files
- --noHTTPCache prevent HTTP caching
- --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
- -p, --port int port on which the server will listen (default 1313)
- --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.
- --renderStaticToDisk serve static files from disk and dynamic files from memory
- --renderToDisk serve all files from disk (default is from memory)
+ --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
- --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)
-```
-
-### Options inherited from parent commands
-
-```
- --config string config file (default is hugo.yaml|json|toml)
- --configDir string config dir (default "config")
- --debug debug output
- --log enable Logging
- --logFile string log File path (if set, logging enabled automatically)
- --quiet build in quiet mode
- -v, --verbose verbose output
- --verboseLog verbose logging
+ -v, --verbose verbose output
+ --verboseLog verbose logging
```
### SEE ALSO
---
## 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
--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)
## 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`).
: 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
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
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 = ""
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 >}}
To define entries for the "main" menu:
-{{< code-toggle file="config" copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
[[menu.main]]
name = 'Home'
pageRef = '/'
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'
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'
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"
{{< 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"
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 }}
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 >}}
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
Example:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
[languages]
[languages.fr]
baseURL = "https://example.fr"
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
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]
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'
For example:
-{{< code-toggle file="config" copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
[languages.de]
languageCode = 'de-DE'
languageName = 'Deutsch'
: 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.
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
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
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.
If your site configuration is private:
-{{< code-toggle file=config copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
[services.instagram]
accessToken = 'xxx'
{{< /code-toggle >}}
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]
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"
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 >}}
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"
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 >}}
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 >}}
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 >}}
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 >}}
[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 >}}
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 >}}
To enable:
-{{< code-toggle file="config" copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
canonifyURLs = true
{{< /code-toggle >}}
To enable:
-{{< code-toggle file="config" copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
relativeURLs = true
{{< /code-toggle >}}
#### Site configuration example
```text
-{{</* code-toggle file="config" */>}}
+{{</* code-toggle file="hugo" */>}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"
Rendered:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
baseURL = 'https://example.org'
languageCode = 'en-US'
title = "Example Site"
--- /dev/null
+---
+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
--- /dev/null
+---
+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
\ No newline at end of file
`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 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
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".
+Owner
+: (`*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`).
-Version (string)
-: The module version.
+Path
+: (`string`) The module path or the path below your `themes` directory (e.g., `github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2`).
-Vendor (bool)
-: Whether this dependency is vendored.
+Replace
+: (`*hugo.Dependency`) Replaced by this dependency.
-Time (time.Time)
-: Time version was created.
+Time
+: (`time.Time`) The time that the version was created (e.g., `2022-02-13 15:11:28 +0000 UTC`).
-Owner
-: In the dependency tree, this is the first module that defines this module as a dependency.
+Vendor
+: (`bool`) Returns `true` if the dependency is vendored.
-Replace (*Dependency)
-: Replaced by this dependency.
+Version
+: (`string`) The module version (e.g., `v2.21100.20000`).
An example table listing the dependencies:
```html
- <h2>Dependencies</h2>
+<h2>Dependencies</h2>
<table class="table table-dark">
<thead>
<tr>
| | *If one of the numbers is a float, the result is a float.* | `{{ div 6 4.0 }}` → `1.5` |
| `mod` | Modulus of two integers. | `{{ mod 15 3 }}` → `0` |
| `modBool` | Boolean of modulus of two integers. Evaluates to `true` if result equals 0. | `{{ modBool 15 3 }}` → `true` |
+| `math.Abs` | Returns the absolute value of the given number. | `{{ math.Abs -2.1 }}` → `2.1` |
| `math.Ceil` | Returns the least integer value greater than or equal to the given number. | `{{ math.Ceil 2.1 }}` → `3` |
| `math.Floor` | Returns the greatest integer value less than or equal to the given number. | `{{ math.Floor 1.9 }}` → `1` |
| `math.Log` | Returns the natural logarithm of the given number. | `{{ math.Log 42 }}` → `3.737` |
**Configuration**
-{{< code-toggle file="config" copy=false >}}
+{{< code-toggle file="hugo" copy=false >}}
[params]
display_toc = true
{{< /code-toggle >}}
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 >}}
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"
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"
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 >}}
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"
--- /dev/null
+---
+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/
The user can override the default:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
[params]
mainSections = ["blog", "docs"]
{{< /code-toggle >}}
## 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.
- 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 >}}
```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"```
### related
-: See [Related Content](/content-management/related/#configure-related-content).
+See [Related Content](/content-management/related/#configure-related-content).
### relativeURLs
The `build` configuration section contains global build-related configuration options.
-{{< code-toggle file="config">}}
+{{< code-toggle file="hugo" >}}
[build]
useResourceCacheWhen="fallback"
writeStats = false
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 = "/**"
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:
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 >}}
### 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"]
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 >}}
An example:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
[frontmatter]
lastmod = ["lastmod", ":fileModTime", ":default"]
{{< /code-toggle >}}
An example:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
[frontmatter]
date = [":filename", ":default"]
{{< /code-toggle >}}
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"
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
├── public/
├── static/
├── themes/
-└── config.toml
+└── hugo.toml
```
## Directory Structure Explained
[`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.
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.
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
```
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.
## 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/'
## Module Config: Top level
-{{< code-toggle file="config">}}
+{{< code-toggle file="hugo" >}}
[module]
noVendor = ""
proxy = "direct"
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 = ""
## Module Config: imports
-{{< code-toggle file="config">}}
+{{< code-toggle file="hugo" >}}
[module]
[[module.imports]]
path = "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v"
: 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.
{{% /note %}}
**Default mounts**
-{{< code-toggle file="config">}}
+{{< code-toggle file="hugo" >}}
[module]
[[module.mounts]]
source="content"
: One or more glob patterns matching files to exclude.
**Example**
-{{< code-toggle file="config">}}
+{{< code-toggle file="hugo" >}}
[module]
[[module.mounts]]
source="content"
{{% /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`.
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)
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"
`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.
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 >}}
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 >}}
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 >}}
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"]
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"
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 >}}
For instance, you might declare the following:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
params:
copyrighthtml: "Copyright © 2017 John Doe. All Rights Reserved."
twitteruser: "spf13"
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"]
**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"]
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"
Example from site config file:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
[outputs]
home = ["HTML", "AMP", "RSS"]
page = ["HTML"]
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 >}}
## 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."
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 >}}
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'
You may disable sitemap generation in your site configuration:
-{{< code-toggle file="config" >}}
+{{< code-toggle file="hugo" >}}
disableKinds = ['sitemap']
{{</ code-toggle >}}
: 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.
{{ $.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
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]
"hlsl"
]
},
+ {
+ "Name": "HolyC",
+ "Aliases": [
+ "holyc"
+ ]
+ },
{
"Name": "HTML",
"Aliases": [
"nasm"
]
},
+ {
+ "Name": "Natural",
+ "Aliases": [
+ "natural"
+ ]
+ },
{
"Name": "Newspeak",
"Aliases": [
"yang"
]
},
+ {
+ "Name": "Z80 Assembly",
+ "Aliases": [
+ "z80"
+ ]
+ },
{
"Name": "Zed",
"Aliases": [
"wrapStandAloneImageWithinParagraph": true
},
"extensions": {
- "typographer": true,
+ "typographer": {
+ "disable": false,
+ "leftSingleQuote": "\u0026lsquo;",
+ "rightSingleQuote": "\u0026rsquo;",
+ "leftDoubleQuote": "\u0026ldquo;",
+ "rightDoubleQuote": "\u0026rdquo;",
+ "enDash": "\u0026ndash;",
+ "emDash": "\u0026mdash;",
+ "ellipsis": "\u0026hellip;",
+ "leftAngleQuote": "\u0026laquo;",
+ "rightAngleQuote": "\u0026raquo;",
+ "apostrophe": "\u0026rsquo;"
+ },
"footnote": true,
"definitionList": true,
"table": true,
"js": {
"precision": 0,
"keepVarNames": false,
- "noNullishOperator": false
+ "noNullishOperator": false,
+ "version": 0
},
"json": {
"precision": 0,
]
},
"http": {
+ "mediaTypes": null,
"methods": [
"(?i)GET|POST"
],
"mainType": "application",
"subType": "json",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "json",
- "fullSuffix": ".json"
- },
"type": "application/json",
"string": "application/json",
"suffixes": [
"mainType": "application",
"subType": "manifest",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "webmanifest",
- "fullSuffix": ".webmanifest"
- },
"type": "application/manifest+json",
"string": "application/manifest+json",
"suffixes": [
"mainType": "application",
"subType": "octet-stream",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "",
- "fullSuffix": ""
- },
"type": "application/octet-stream",
"string": "application/octet-stream",
"suffixes": [
"mainType": "application",
"subType": "pdf",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "pdf",
- "fullSuffix": ".pdf"
- },
"type": "application/pdf",
"string": "application/pdf",
"suffixes": [
"mainType": "application",
"subType": "rss",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "xml",
- "fullSuffix": ".xml"
- },
"type": "application/rss+xml",
"string": "application/rss+xml",
"suffixes": [
"mainType": "application",
"subType": "toml",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "toml",
- "fullSuffix": ".toml"
- },
"type": "application/toml",
"string": "application/toml",
"suffixes": [
"toml"
]
},
+ {
+ "mainType": "application",
+ "subType": "wasm",
+ "delimiter": ".",
+ "type": "application/wasm",
+ "string": "application/wasm",
+ "suffixes": [
+ "wasm"
+ ]
+ },
{
"mainType": "application",
"subType": "xml",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "xml",
- "fullSuffix": ".xml"
- },
"type": "application/xml",
"string": "application/xml",
"suffixes": [
"mainType": "application",
"subType": "yaml",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "yaml",
- "fullSuffix": ".yaml"
- },
"type": "application/yaml",
"string": "application/yaml",
"suffixes": [
"mainType": "font",
"subType": "otf",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "otf",
- "fullSuffix": ".otf"
- },
"type": "font/otf",
"string": "font/otf",
"suffixes": [
"mainType": "font",
"subType": "ttf",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "ttf",
- "fullSuffix": ".ttf"
- },
"type": "font/ttf",
"string": "font/ttf",
"suffixes": [
"mainType": "image",
"subType": "bmp",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "bmp",
- "fullSuffix": ".bmp"
- },
"type": "image/bmp",
"string": "image/bmp",
"suffixes": [
"mainType": "image",
"subType": "gif",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "gif",
- "fullSuffix": ".gif"
- },
"type": "image/gif",
"string": "image/gif",
"suffixes": [
"mainType": "image",
"subType": "jpeg",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "jpg",
- "fullSuffix": ".jpg"
- },
"type": "image/jpeg",
"string": "image/jpeg",
"suffixes": [
"mainType": "image",
"subType": "png",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "png",
- "fullSuffix": ".png"
- },
"type": "image/png",
"string": "image/png",
"suffixes": [
"mainType": "image",
"subType": "svg",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "svg",
- "fullSuffix": ".svg"
- },
"type": "image/svg+xml",
"string": "image/svg+xml",
"suffixes": [
"svg"
]
},
+ {
+ "mainType": "image",
+ "subType": "tiff",
+ "delimiter": ".",
+ "type": "image/tiff",
+ "string": "image/tiff",
+ "suffixes": [
+ "tif",
+ "tiff"
+ ]
+ },
{
"mainType": "image",
"subType": "webp",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "webp",
- "fullSuffix": ".webp"
- },
"type": "image/webp",
"string": "image/webp",
"suffixes": [
"mainType": "text",
"subType": "calendar",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "ics",
- "fullSuffix": ".ics"
- },
"type": "text/calendar",
"string": "text/calendar",
"suffixes": [
"mainType": "text",
"subType": "css",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "css",
- "fullSuffix": ".css"
- },
"type": "text/css",
"string": "text/css",
"suffixes": [
"mainType": "text",
"subType": "csv",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "csv",
- "fullSuffix": ".csv"
- },
"type": "text/csv",
"string": "text/csv",
"suffixes": [
"mainType": "text",
"subType": "html",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "html",
- "fullSuffix": ".html"
- },
"type": "text/html",
"string": "text/html",
"suffixes": [
"mainType": "text",
"subType": "javascript",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "js",
- "fullSuffix": ".js"
- },
"type": "text/javascript",
"string": "text/javascript",
"suffixes": [
"mainType": "text",
"subType": "jsx",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "jsx",
- "fullSuffix": ".jsx"
- },
"type": "text/jsx",
"string": "text/jsx",
"suffixes": [
"mainType": "text",
"subType": "markdown",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "md",
- "fullSuffix": ".md"
- },
"type": "text/markdown",
"string": "text/markdown",
"suffixes": [
"mainType": "text",
"subType": "plain",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "txt",
- "fullSuffix": ".txt"
- },
"type": "text/plain",
"string": "text/plain",
"suffixes": [
"mainType": "text",
"subType": "tsx",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "tsx",
- "fullSuffix": ".tsx"
- },
"type": "text/tsx",
"string": "text/tsx",
"suffixes": [
"mainType": "text",
"subType": "typescript",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "ts",
- "fullSuffix": ".ts"
- },
"type": "text/typescript",
"string": "text/typescript",
"suffixes": [
"mainType": "text",
"subType": "x-sass",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "sass",
- "fullSuffix": ".sass"
- },
"type": "text/x-sass",
"string": "text/x-sass",
"suffixes": [
"mainType": "text",
"subType": "x-scss",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "scss",
- "fullSuffix": ".scss"
- },
"type": "text/x-scss",
"string": "text/x-scss",
"suffixes": [
"mainType": "video",
"subType": "3gpp",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "3gpp",
- "fullSuffix": ".3gpp"
- },
"type": "video/3gpp",
"string": "video/3gpp",
"suffixes": [
"mainType": "video",
"subType": "mp4",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "mp4",
- "fullSuffix": ".mp4"
- },
"type": "video/mp4",
"string": "video/mp4",
"suffixes": [
"mainType": "video",
"subType": "mpeg",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "mpg",
- "fullSuffix": ".mpg"
- },
"type": "video/mpeg",
"string": "video/mpeg",
"suffixes": [
"mainType": "video",
"subType": "ogg",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "ogv",
- "fullSuffix": ".ogv"
- },
"type": "video/ogg",
"string": "video/ogg",
"suffixes": [
"mainType": "video",
"subType": "webm",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "webm",
- "fullSuffix": ".webm"
- },
"type": "video/webm",
"string": "video/webm",
"suffixes": [
"mainType": "video",
"subType": "x-msvideo",
"delimiter": ".",
- "firstSuffix": {
- "suffix": "avi",
- "fullSuffix": ".avi"
- },
"type": "video/x-msvideo",
"string": "video/x-msvideo",
"suffixes": [
"formats": [
{
"mediaType": "text/html",
- "name": "HTML",
+ "name": "html",
"path": "",
"baseName": "index",
"rel": "canonical",
},
{
"mediaType": "text/html",
- "name": "AMP",
+ "name": "amp",
"path": "amp",
"baseName": "index",
"rel": "amphtml",
"weight": 0
},
{
- "mediaType": "text/css",
- "name": "CSS",
+ "mediaType": "text/calendar",
+ "name": "calendar",
"path": "",
- "baseName": "styles",
- "rel": "stylesheet",
- "protocol": "",
+ "baseName": "index",
+ "rel": "alternate",
+ "protocol": "webcal://",
"isPlainText": true,
"isHTML": false,
"noUgly": false,
- "notAlternative": true,
+ "notAlternative": false,
"permalinkable": false,
"weight": 0
},
{
- "mediaType": "text/csv",
- "name": "CSV",
+ "mediaType": "text/css",
+ "name": "css",
"path": "",
- "baseName": "index",
- "rel": "alternate",
+ "baseName": "styles",
+ "rel": "stylesheet",
"protocol": "",
"isPlainText": true,
"isHTML": false,
"noUgly": false,
- "notAlternative": false,
+ "notAlternative": true,
"permalinkable": false,
"weight": 0
},
{
- "mediaType": "text/calendar",
- "name": "Calendar",
+ "mediaType": "text/csv",
+ "name": "csv",
"path": "",
"baseName": "index",
"rel": "alternate",
- "protocol": "webcal://",
+ "protocol": "",
"isPlainText": true,
"isHTML": false,
"noUgly": false,
},
{
"mediaType": "application/json",
- "name": "JSON",
+ "name": "json",
"path": "",
"baseName": "index",
"rel": "alternate",
},
{
"mediaType": "text/markdown",
- "name": "MARKDOWN",
+ "name": "markdown",
"path": "",
"baseName": "index",
"rel": "alternate",
},
{
"mediaType": "text/plain",
- "name": "ROBOTS",
+ "name": "robots",
"path": "",
"baseName": "robots",
"rel": "alternate",
},
{
"mediaType": "application/rss+xml",
- "name": "RSS",
+ "name": "rss",
"path": "",
"baseName": "index",
"rel": "alternate",
},
{
"mediaType": "application/xml",
- "name": "Sitemap",
+ "name": "sitemap",
"path": "",
"baseName": "sitemap",
"rel": "sitemap",
},
{
"mediaType": "application/manifest+json",
- "name": "WebAppManifest",
+ "name": "webappmanifest",
"path": "",
"baseName": "manifest",
"rel": "manifest",
{
"Example": "Single page in \"posts\" section",
"Kind": "page",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/single.html.html",
{
"Example": "Base template for single page in \"posts\" section",
"Kind": "page",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/single-baseof.html.html",
{
"Example": "Single page in \"posts\" section with layout set",
"Kind": "page",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/demolayout.html.html",
{
"Example": "Base template for single page in \"posts\" section with layout set",
"Kind": "page",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/demolayout-baseof.html.html",
{
"Example": "AMP single page",
"Kind": "page",
- "OutputFormat": "AMP",
+ "OutputFormat": "amp",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/single.amp.html",
{
"Example": "AMP single page, French language",
"Kind": "page",
- "OutputFormat": "AMP",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
- "layouts/posts/single.fr.amp.html",
- "layouts/posts/single.amp.html",
+ "layouts/posts/single.fr.html.html",
+ "layouts/posts/single.html.html",
"layouts/posts/single.fr.html",
"layouts/posts/single.html",
- "layouts/_default/single.fr.amp.html",
- "layouts/_default/single.amp.html",
+ "layouts/_default/single.fr.html.html",
+ "layouts/_default/single.html.html",
"layouts/_default/single.fr.html",
"layouts/_default/single.html"
]
{
"Example": "Home page",
"Kind": "home",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/index.html.html",
{
"Example": "Base template for home page",
"Kind": "home",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/index-baseof.html.html",
{
"Example": "Home page with type set",
"Kind": "home",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/demotype/index.html.html",
{
"Example": "Base template for home page with type set",
"Kind": "home",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/demotype/index-baseof.html.html",
{
"Example": "Home page with layout set",
"Kind": "home",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/demolayout.html.html",
{
"Example": "AMP home, French language",
"Kind": "home",
- "OutputFormat": "AMP",
+ "OutputFormat": "amp",
"Suffix": "html",
"Template Lookup Order": [
"layouts/index.fr.amp.html",
{
"Example": "JSON home",
"Kind": "home",
- "OutputFormat": "JSON",
+ "OutputFormat": "json",
"Suffix": "json",
"Template Lookup Order": [
"layouts/index.json.json",
{
"Example": "RSS home",
"Kind": "home",
- "OutputFormat": "RSS",
+ "OutputFormat": "rss",
"Suffix": "xml",
"Template Lookup Order": [
"layouts/index.rss.xml",
{
"Example": "RSS section posts",
"Kind": "section",
- "OutputFormat": "RSS",
+ "OutputFormat": "rss",
"Suffix": "xml",
"Template Lookup Order": [
"layouts/posts/section.rss.xml",
{
"Example": "Taxonomy in categories",
"Kind": "taxonomy",
- "OutputFormat": "RSS",
+ "OutputFormat": "rss",
"Suffix": "xml",
"Template Lookup Order": [
"layouts/categories/category.terms.rss.xml",
{
"Example": "Term in categories",
"Kind": "term",
- "OutputFormat": "RSS",
+ "OutputFormat": "rss",
"Suffix": "xml",
"Template Lookup Order": [
"layouts/categories/term.rss.xml",
{
"Example": "Section list for \"posts\" section",
"Kind": "section",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/posts.html.html",
{
"Example": "Section list for \"posts\" section with type set to \"blog\"",
"Kind": "section",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/blog/posts.html.html",
{
"Example": "Section list for \"posts\" section with layout set to \"demoLayout\"",
"Kind": "section",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/posts/demolayout.html.html",
{
"Example": "Taxonomy list in categories",
"Kind": "taxonomy",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/categories/category.terms.html.html",
{
"Example": "Taxonomy term in categories",
"Kind": "term",
- "OutputFormat": "HTML",
+ "OutputFormat": "html",
"Suffix": "html",
"Template Lookup Order": [
"layouts/categories/term.html.html",
},
"crypto": {
"FNV32a": {
- "Description": "FNV32a hashes v using fnv32a algorithm.",
+ "Description": "FNV32a hashes v using fnv32a algorithm.\n\u003cdocsmeta\u003e{\"newIn\": \"0.98.0\" }\u003c/docsmeta\u003e",
"Args": [
"v"
],
"map[string]interface {}{\n \"Hugo\": \"Rocks!\",\n}"
]
]
+ },
+ "VisualizeSpaces": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
}
},
"diagrams": {
"Args": null,
"Aliases": null,
"Examples": null
+ },
+ "WorkingDir": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
}
},
"images": {
]
},
"FormatNumberCustom": {
- "Description": "FormatNumberCustom formats a number with the given precision using the\nnegative, decimal, and grouping options. The `options`\nparameter is a string consisting of `\u003cnegative\u003e \u003cdecimal\u003e \u003cgrouping\u003e`. The\ndefault `options` value is `- . ,`.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.\n\nFor a simpler function that adapts to the current language, see FormatNumber.",
+ "Description": "FormatNumberCustom formats a number with the given precision. The first\noptions parameter is a space-delimited string of characters to represent\nnegativity, the decimal point, and grouping. The default value is `- . ,`.\nThe second options parameter defines an alternate delimiting character.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.\n\nFor a simpler function that adapts to the current language, see FormatNumber.",
"Args": [
"precision",
"number",
"{{ lang.FormatNumberCustom 0 -12345.6789 \"- . ,\" }}",
"-12,346"
],
+ [
+ "{{ lang.FormatNumberCustom 0 -12345.6789 \"-|.| \" \"|\" }}",
+ "-12 346"
+ ],
[
"{{ -98765.4321 | lang.FormatNumberCustom 2 }}",
"-98,765.43"
"Translate": {
"Description": "Translate returns a translated string for id.",
"Args": [
+ "ctx",
"id",
"args"
],
}
},
"math": {
+ "Abs": {
+ "Description": "Abs returns the absolute value of n.",
+ "Args": [
+ "n"
+ ],
+ "Aliases": null,
+ "Examples": [
+ [
+ "{{ math.Abs -2.1 }}",
+ "2.1"
+ ]
+ ]
+ },
"Add": {
- "Description": "Add adds the two addends n1 and n2.",
+ "Description": "Add adds the multivalued addends n1 and n2 or more values.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": [
"add"
"Div": {
"Description": "Div divides n1 by n2.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": [
"div"
]
},
"Max": {
- "Description": "Max returns the greater of the two numbers n1 or n2.",
+ "Description": "Max returns the greater of the multivalued numbers n1 and n2 or more values.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": null,
"Examples": [
]
},
"Min": {
- "Description": "Min returns the smaller of two numbers n1 or n2.",
+ "Description": "Min returns the smaller of multivalued numbers n1 and n2 or more values.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": null,
"Examples": [
]
},
"Mul": {
- "Description": "Mul multiplies the two numbers n1 and n2.",
+ "Description": "Mul multiplies the multivalued numbers n1 and n2 or more values.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": [
"mul"
]
},
"Sub": {
- "Description": "Sub subtracts n2 from n1.",
+ "Description": "Sub subtracts multivalued.",
"Args": [
- "n1",
- "n2"
+ "inputs"
],
"Aliases": [
"sub"
"Examples": null
},
"GetRemote": {
- "Description": "GetRemote gets the URL (via HTTP(s)) in the first argument in args and creates Resource object that can be used for\nfurther transformations.\n\nA second argument may be provided with an option map.\n\nNote: This method does not return any error as a second argument,\nfor any error situations the error can be checked in .Err.",
+ "Description": "GetRemote gets the URL (via HTTP(s)) in the first argument in args and creates Resource object that can be used for\nfurther transformations.\n\nA second argument may be provided with an option map.\n\nNote: This method does not return any error as a second return value,\nfor any error situations the error can be checked in .Err.",
"Args": [
"args"
],
"Examples": null
},
"ToCSS": {
- "Description": "ToCSS converts the given Resource to CSS. You can optional provide an Options\nobject or a target path (string) as first argument.",
+ "Description": "ToCSS converts the given Resource to CSS. You can optional provide an Options object\nas second argument. As an option, you can e.g. specify e.g. the target path (string)\nfor the converted CSS resource.",
"Args": [
"args"
],
}
},
"site": {
+ "AllPages": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "Author": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "Authors": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"BaseURL": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "BuildDrafts": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "Config": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "Copyright": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Current": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "DisqusShortname": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"GetIdentity": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "GetPage": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "GetPageWithTemplateInfo": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "GoogleAnalytics": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Home": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "IsMultiLingual": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"IsServer": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "LanguageCode": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "LanguagePrefix": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
+ "Languages": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"LastChange": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "MainSections": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Menus": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "Param": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Params": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "Sections": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"ServerPort": {
"Description": "",
"Args": null,
"Aliases": null,
"Examples": null
},
+ "Social": {
+ "Description": "",
+ "Args": null,
+ "Aliases": null,
+ "Examples": null
+ },
"Taxonomies": {
"Description": "",
"Args": null,
]
},
"FindRESubmatch": {
- "Description": "FindRESubmatch returns returns a slice of strings holding the text of the leftmost match of the regular expression in s and the matches, if any, of its subexpressions.\n\nBy default all matches will be included. The number of matches can be limited with the optional limit parameter. A return value of nil indicates no match.",
+ "Description": "FindRESubmatch returns a slice of all successive matches of the regular\nexpression in content. Each element is a slice of strings holding the text\nof the leftmost match of the regular expression and the matches, if any, of\nits subexpressions.\n\nBy default all matches will be included. The number of matches can be\nlimited with the optional limit parameter. A return value of nil indicates\nno match.",
"Args": [
"expr",
"content",
]
},
"HasSuffix": {
- "Description": "",
- "Args": null,
- "Aliases": null,
- "Examples": null
+ "Description": "HasSuffix tests whether the input s begins with suffix.",
+ "Args": [
+ "s",
+ "suffix"
+ ],
+ "Aliases": [
+ "hasSuffix"
+ ],
+ "Examples": [
+ [
+ "{{ hasSuffix \"Hugo\" \"go\" }}",
+ "true"
+ ],
+ [
+ "{{ hasSuffix \"Hugo\" \"du\" }}",
+ "false"
+ ]
+ ]
},
"Repeat": {
"Description": "Repeat returns a new string consisting of n copies of the string s.",
]
]
},
+ "JoinPath": {
+ "Description": "JoinPath joins the provided elements into a URL string and cleans the result\nof any ./ or ../ elements. If the argument list is empty, JoinPath returns\nan empty string.",
+ "Args": [
+ "elements"
+ ],
+ "Aliases": null,
+ "Examples": [
+ [
+ "{{ urls.JoinPath \"https://example.org\" \"foo\" }}",
+ "https://example.org/foo"
+ ],
+ [
+ "{{ urls.JoinPath (slice \"a\" \"b\") }}",
+ "a/b"
+ ]
+ ]
+ },
"Parse": {
"Description": "",
"Args": null,
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
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=
{{- /* 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 }}
{{ $version := .Get 0 }}
{{ if not $version }}
-{{ errorf "Missing version in new-in shortcode "}}
+ {{ 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>
command = "hugo --gc --minify"
[context.production.environment]
-HUGO_VERSION = "0.111.3"
+HUGO_VERSION = "0.112.3"
HUGO_ENV = "production"
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"
projects / brevno-suite / hugo / commitdiff