From d3927310d5b2404c3238f9b899db3329ea516490 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Sat, 27 May 2023 16:59:59 +0200 Subject: [PATCH] Squashed 'docs/' changes from 39af43ef1..1798dc0d5 1798dc0d5 Update theme 403fa716e Update CLI documentation (#2092) aade5a09e Correct media subtype example 53cd9dea6 netlify: Hugo 0.112.3 b78b86cb1 Add source/target warning to resources.Copy (#2091) 50c299729 netlify: Hugo 0.112.2 73197046f Change config.xxx to hugo.xxx throughout the documentation (#2090) d489d4c6f Add hugo.WorkingDir to docs (#2089) 7487df809 Fix typos (#2088) 6d0572cd6 netlify: Hugo 0.112.1 6838600b2 netlify: Hugo 0.112.0 513e7a80f Merge branch 'tempv0.112.0' 91eb44275 Some more about 0.112.0 bd3b33a27 docs: Regen docshelper fb3027daf docs: Regen CLI docs 8e7b8e987 Merge commit 'f96384a3b596f9bc0a3a035970b09b2c601f0ccb' a942ceef4 tpl/tplimpl: Add img loading attribute to figure shortcode (#10927) 0e0c7b25e tpl/urls: Return empty string when JoinPath has zero args 310ce949a tpl/urls: Add JoinPath template function ae435ca77 tpl: Add math.Abs f340139f8 Revert "Update syntax-highlighting.md (#10929)" (#10930) 917a0e24d Update syntax-highlighting.md (#10929) git-subtree-dir: docs git-subtree-split: 1798dc0d54ce048dd975863b490cd809ef14268a --- .../gohugoioTheme/layouts/index.headers | 3 - _vendor/modules.txt | 2 +- content/en/about/hugo-and-gdpr.md | 10 +- content/en/commands/hugo.md | 3 +- content/en/commands/hugo_completion.md | 2 + content/en/commands/hugo_completion_bash.md | 2 + content/en/commands/hugo_completion_fish.md | 2 + .../en/commands/hugo_completion_powershell.md | 2 + content/en/commands/hugo_completion_zsh.md | 4 +- content/en/commands/hugo_config.md | 32 +- content/en/commands/hugo_config_mounts.md | 4 +- content/en/commands/hugo_convert.md | 38 +- content/en/commands/hugo_convert_toJSON.md | 4 +- content/en/commands/hugo_convert_toTOML.md | 4 +- content/en/commands/hugo_convert_toYAML.md | 4 +- content/en/commands/hugo_deploy.md | 46 +- content/en/commands/hugo_env.md | 9 +- content/en/commands/hugo_gen.md | 6 + content/en/commands/hugo_gen_chromastyles.md | 4 +- content/en/commands/hugo_gen_doc.md | 15 +- content/en/commands/hugo_gen_man.md | 8 +- content/en/commands/hugo_import.md | 6 + content/en/commands/hugo_import_jekyll.md | 6 +- content/en/commands/hugo_list.md | 36 +- content/en/commands/hugo_list_all.md | 4 +- content/en/commands/hugo_list_drafts.md | 4 +- content/en/commands/hugo_list_expired.md | 4 +- content/en/commands/hugo_list_future.md | 4 +- content/en/commands/hugo_mod.md | 59 +- content/en/commands/hugo_mod_clean.md | 10 +- content/en/commands/hugo_mod_get.md | 4 +- content/en/commands/hugo_mod_graph.md | 7 +- content/en/commands/hugo_mod_init.md | 18 +- content/en/commands/hugo_mod_npm.md | 4 +- content/en/commands/hugo_mod_npm_pack.md | 4 +- content/en/commands/hugo_mod_tidy.md | 4 +- content/en/commands/hugo_mod_vendor.md | 9 +- content/en/commands/hugo_mod_verify.md | 5 +- content/en/commands/hugo_new.md | 66 +-- content/en/commands/hugo_new_content.md | 57 ++ content/en/commands/hugo_new_site.md | 33 +- content/en/commands/hugo_new_theme.md | 41 +- content/en/commands/hugo_server.md | 115 ++-- content/en/commands/hugo_version.md | 8 +- .../en/content-management/cross-references.md | 2 +- content/en/content-management/front-matter.md | 2 +- .../image-processing/index.md | 4 +- content/en/content-management/menus.md | 8 +- content/en/content-management/multilingual.md | 22 +- .../en/content-management/page-resources.md | 2 +- content/en/content-management/related.md | 4 +- content/en/content-management/shortcodes.md | 5 +- content/en/content-management/static-files.md | 2 +- content/en/content-management/taxonomies.md | 8 +- content/en/content-management/urls.md | 14 +- content/en/contribute/documentation.md | 4 +- content/en/functions/hasPrefix.md | 21 + content/en/functions/hasSuffix.md | 21 + content/en/functions/hugo.md | 71 +-- content/en/functions/math.md | 1 + content/en/functions/param.md | 2 +- content/en/functions/safeHTML.md | 4 +- content/en/functions/safeHTMLAttr.md | 2 +- content/en/functions/safeURL.md | 4 +- content/en/functions/sort.md | 4 +- content/en/functions/urls.JoinPath.md | 25 + content/en/functions/where.md | 2 +- content/en/getting-started/configuration.md | 58 +- .../en/getting-started/directory-structure.md | 4 +- content/en/getting-started/quick-start.md | 8 +- content/en/hugo-modules/configuration.md | 12 +- content/en/hugo-modules/theme-components.md | 8 +- content/en/hugo-modules/use-modules.md | 2 +- content/en/hugo-pipes/introduction.md | 13 +- content/en/hugo-pipes/postprocess.md | 2 +- content/en/templates/internal.md | 12 +- content/en/templates/introduction.md | 2 +- content/en/templates/output-formats.md | 8 +- content/en/templates/robots.md | 2 +- content/en/templates/rss.md | 4 +- content/en/templates/shortcode-templates.md | 2 +- content/en/templates/sitemap-template.md | 4 +- content/en/variables/page.md | 4 +- content/en/variables/site.md | 2 +- data/docs.json | 510 ++++++++++-------- go.mod | 2 +- go.sum | 2 + layouts/shortcodes/code-toggle.html | 2 +- layouts/shortcodes/new-in.html | 11 +- netlify.toml | 8 +- 90 files changed, 937 insertions(+), 691 deletions(-) create mode 100644 content/en/commands/hugo_new_content.md create mode 100644 content/en/functions/hasPrefix.md create mode 100644 content/en/functions/hasSuffix.md create mode 100644 content/en/functions/urls.JoinPath.md diff --git a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers index fedd73525..1216e42d4 100644 --- a/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers +++ b/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers @@ -3,6 +3,3 @@ X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Referrer-Policy: origin-when-cross-origin -/* - Link: <{{ "dist/app.bundle.js" | relURL }}>; rel=preload; as=script - Link: <{{ "dist/main.css" | relURL }}>; rel=preload; as=style diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 5c4b53271..1c7cac307 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1 +1 @@ -# github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11 +# github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a diff --git a/content/en/about/hugo-and-gdpr.md b/content/en/about/hugo-and-gdpr.md index 3e0a160c7..b028c4543 100644 --- a/content/en/about/hugo-and-gdpr.md +++ b/content/en/about/hugo-and-gdpr.md @@ -27,9 +27,9 @@ toc: true ## All Privacy Settings -Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `config.toml`). +Below are all privacy settings and their default value. These settings need to be put in your site config (e.g. `hugo.toml`). - {{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [privacy] [privacy.disqus] disable = false @@ -58,7 +58,7 @@ privacyEnhanced = false An example Privacy Config that disables all the relevant services in Hugo. With this configuration, the other settings will not matter. - {{< code-toggle file="config">}} + {{< code-toggle file="hugo" >}} [privacy] [privacy.disqus] disable = true @@ -98,7 +98,7 @@ simple **Note:** If you use the _simple mode_ for Instagram and a site styled with Bootstrap 4, you may want to disable the inline styles provided by Hugo: - {{< code-toggle file="config">}} + {{< code-toggle file="hugo" >}} [services] [services.instagram] disableInlineCSS = true @@ -114,7 +114,7 @@ simple **Note:** If you use the _simple mode_ for Twitter, you may want to disable the inline styles provided by Hugo: - {{< code-toggle file="config">}} + {{< code-toggle file="hugo" >}} [services] [services.twitter] disableInlineCSS = true diff --git a/content/en/commands/hugo.md b/content/en/commands/hugo.md index 0b42d5521..8dbdd6231 100644 --- a/content/en/commands/hugo.md +++ b/content/en/commands/hugo.md @@ -39,6 +39,7 @@ hugo [flags] --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages -e, --environment string build environment --forceSyncStatic copy all files when static is changed. + --format string preferred file format (toml, yaml or json) (default "toml") --gc enable to run some cleanup tasks (remove unused cache files) after the build -h, --help help for hugo --ignoreCache ignores the cache directory @@ -82,5 +83,5 @@ hugo [flags] * [hugo mod](/commands/hugo_mod/) - Various Hugo Modules helpers. * [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo server](/commands/hugo_server/) - A high performance webserver -* [hugo version](/commands/hugo_version/) - Print the version number of Hugo +* [hugo version](/commands/hugo_version/) - Print Hugo version and environment info diff --git a/content/en/commands/hugo_completion.md b/content/en/commands/hugo_completion.md index 5387f7aed..7ab87f800 100644 --- a/content/en/commands/hugo_completion.md +++ b/content/en/commands/hugo_completion.md @@ -26,7 +26,9 @@ See each sub-command's help for details on how to use the generated script. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_bash.md b/content/en/commands/hugo_completion_bash.md index 22d948647..a4d4d6f11 100644 --- a/content/en/commands/hugo_completion_bash.md +++ b/content/en/commands/hugo_completion_bash.md @@ -49,7 +49,9 @@ hugo completion bash --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_fish.md b/content/en/commands/hugo_completion_fish.md index 481507044..6fe2d7f16 100644 --- a/content/en/commands/hugo_completion_fish.md +++ b/content/en/commands/hugo_completion_fish.md @@ -40,7 +40,9 @@ hugo completion fish [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_powershell.md b/content/en/commands/hugo_completion_powershell.md index 7e6abb9f4..614023dbb 100644 --- a/content/en/commands/hugo_completion_powershell.md +++ b/content/en/commands/hugo_completion_powershell.md @@ -37,7 +37,9 @@ hugo completion powershell [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_completion_zsh.md b/content/en/commands/hugo_completion_zsh.md index 9612817e3..7e17bc96d 100644 --- a/content/en/commands/hugo_completion_zsh.md +++ b/content/en/commands/hugo_completion_zsh.md @@ -18,7 +18,7 @@ to enable it. You can execute the following once: To load completions in your current shell session: - source <(hugo completion zsh); compdef _hugo hugo + source <(hugo completion zsh) To load completions for every new session, execute once: @@ -51,7 +51,9 @@ hugo completion zsh [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_config.md b/content/en/commands/hugo_config.md index ca73bbe4b..0c54f0e6d 100644 --- a/content/en/commands/hugo_config.md +++ b/content/en/commands/hugo_config.md @@ -12,31 +12,33 @@ Print the site configuration Print the site configuration, both default and custom settings. ``` -hugo config [flags] +hugo config [command] [flags] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for config - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -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 diff --git a/content/en/commands/hugo_config_mounts.md b/content/en/commands/hugo_config_mounts.md index 825ddf1b5..1019f5102 100644 --- a/content/en/commands/hugo_config_mounts.md +++ b/content/en/commands/hugo_config_mounts.md @@ -8,7 +8,7 @@ url: /commands/hugo_config_mounts/ Print the configured file mounts ``` -hugo config mounts [flags] +hugo config mounts [flags] [args] ``` ### Options @@ -24,7 +24,9 @@ hugo config mounts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert.md b/content/en/commands/hugo_convert.md index e8015a5b5..0c5384fbb 100644 --- a/content/en/commands/hugo_convert.md +++ b/content/en/commands/hugo_convert.md @@ -13,30 +13,36 @@ Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information. +``` +hugo convert [command] [flags] +``` + ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for convert - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -o, --output string filesystem path to write files to - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory - --unsafe enable less safe operations, please backup first + -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 diff --git a/content/en/commands/hugo_convert_toJSON.md b/content/en/commands/hugo_convert_toJSON.md index 162c42d0a..73c2fc303 100644 --- a/content/en/commands/hugo_convert_toJSON.md +++ b/content/en/commands/hugo_convert_toJSON.md @@ -13,7 +13,7 @@ toJSON converts all front matter in the content directory to use JSON for the front matter. ``` -hugo convert toJSON [flags] +hugo convert toJSON [flags] [args] ``` ### Options @@ -29,7 +29,9 @@ hugo convert toJSON [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert_toTOML.md b/content/en/commands/hugo_convert_toTOML.md index 50c0c9ebf..9141eb1a2 100644 --- a/content/en/commands/hugo_convert_toTOML.md +++ b/content/en/commands/hugo_convert_toTOML.md @@ -13,7 +13,7 @@ toTOML converts all front matter in the content directory to use TOML for the front matter. ``` -hugo convert toTOML [flags] +hugo convert toTOML [flags] [args] ``` ### Options @@ -29,7 +29,9 @@ hugo convert toTOML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_convert_toYAML.md b/content/en/commands/hugo_convert_toYAML.md index bf2d28421..a932921cf 100644 --- a/content/en/commands/hugo_convert_toYAML.md +++ b/content/en/commands/hugo_convert_toYAML.md @@ -13,7 +13,7 @@ toYAML converts all front matter in the content directory to use YAML for the front matter. ``` -hugo convert toYAML [flags] +hugo convert toYAML [flags] [args] ``` ### Options @@ -29,7 +29,9 @@ hugo convert toYAML [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_deploy.md b/content/en/commands/hugo_deploy.md index 7b14c30ef..0531664dd 100644 --- a/content/en/commands/hugo_deploy.md +++ b/content/en/commands/hugo_deploy.md @@ -16,38 +16,40 @@ documentation. ``` -hugo deploy [flags] +hugo deploy [flags] [args] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - --confirm ask for confirmation before making changes to the target - --dryRun dry run - -e, --environment string build environment - --force force upload of all files - -h, --help help for deploy - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - --invalidateCDN invalidate the CDN cache listed in the deployment target (default true) - --maxDeletes int maximum # of files to delete, or -1 to disable (default 256) - --workers int number of workers to transfer files. (default 10) - -s, --source string filesystem path to read files relative from - --target string target deployment from deployments section in config file; defaults to the first one - --themesDir string filesystem path to themes directory + --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 diff --git a/content/en/commands/hugo_env.md b/content/en/commands/hugo_env.md index 632614d50..e001c6098 100644 --- a/content/en/commands/hugo_env.md +++ b/content/en/commands/hugo_env.md @@ -9,13 +9,10 @@ Print Hugo version and environment info ### Synopsis -Print Hugo version and environment info. This is useful in Hugo bug reports. - -If you add the -v flag, you will get a full dependency list. - +Print Hugo version and environment info. This is useful in Hugo bug reports ``` -hugo env [flags] +hugo env [flags] [args] ``` ### Options @@ -31,7 +28,9 @@ hugo env [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen.md b/content/en/commands/hugo_gen.md index 281669b59..b589e2e0f 100644 --- a/content/en/commands/hugo_gen.md +++ b/content/en/commands/hugo_gen.md @@ -7,6 +7,10 @@ url: /commands/hugo_gen/ A collection of several useful generators. +``` +hugo gen [command] [flags] +``` + ### Options ``` @@ -20,7 +24,9 @@ A collection of several useful generators. --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_chromastyles.md b/content/en/commands/hugo_gen_chromastyles.md index ed434b1c7..5ea23381d 100644 --- a/content/en/commands/hugo_gen_chromastyles.md +++ b/content/en/commands/hugo_gen_chromastyles.md @@ -14,7 +14,7 @@ Generate CSS stylesheet for the Chroma code highlighter for a given style. This See https://xyproto.github.io/splash/docs/all.html for a preview of the available styles ``` -hugo gen chromastyles [flags] +hugo gen chromastyles [flags] [args] ``` ### Options @@ -33,7 +33,9 @@ hugo gen chromastyles [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_doc.md b/content/en/commands/hugo_gen_doc.md index b6e6a99f2..16593400a 100644 --- a/content/en/commands/hugo_gen_doc.md +++ b/content/en/commands/hugo_gen_doc.md @@ -10,15 +10,14 @@ Generate Markdown documentation for the Hugo CLI. ### Synopsis Generate Markdown documentation for the Hugo CLI. - -This command is, mostly, used to create up-to-date documentation -of Hugo's command-line interface for https://gohugo.io/. - -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 @@ -35,7 +34,9 @@ hugo gen doc [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_gen_man.md b/content/en/commands/hugo_gen_man.md index c37ca2420..3602dcc93 100644 --- a/content/en/commands/hugo_gen_man.md +++ b/content/en/commands/hugo_gen_man.md @@ -10,11 +10,11 @@ Generate man pages for the Hugo CLI ### 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 @@ -31,7 +31,9 @@ hugo gen man [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_import.md b/content/en/commands/hugo_import.md index 70b182902..ad4907d58 100644 --- a/content/en/commands/hugo_import.md +++ b/content/en/commands/hugo_import.md @@ -13,6 +13,10 @@ Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. +``` +hugo import [command] [flags] +``` + ### Options ``` @@ -26,7 +30,9 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_import_jekyll.md b/content/en/commands/hugo_import_jekyll.md index ff0ff549b..10d603bdf 100644 --- a/content/en/commands/hugo_import_jekyll.md +++ b/content/en/commands/hugo_import_jekyll.md @@ -10,11 +10,11 @@ hugo import from Jekyll ### 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 @@ -31,7 +31,9 @@ hugo import jekyll [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list.md b/content/en/commands/hugo_list.md index e2854c568..10a8cf6cb 100644 --- a/content/en/commands/hugo_list.md +++ b/content/en/commands/hugo_list.md @@ -11,30 +11,36 @@ Listing out various types of content Listing out various types of content. -List requires a subcommand, e.g. `hugo list drafts`. +List requires a subcommand, e.g. hugo list drafts + +``` +hugo list [command] [flags] +``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for list - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -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 diff --git a/content/en/commands/hugo_list_all.md b/content/en/commands/hugo_list_all.md index a6f9f94d6..8edd0a4d9 100644 --- a/content/en/commands/hugo_list_all.md +++ b/content/en/commands/hugo_list_all.md @@ -12,7 +12,7 @@ List all posts List all of the posts in your content directory, include drafts, future and expired pages. ``` -hugo list all [flags] +hugo list all [flags] [args] ``` ### Options @@ -28,7 +28,9 @@ hugo list all [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_drafts.md b/content/en/commands/hugo_list_drafts.md index 98c8a047c..5ec870a5d 100644 --- a/content/en/commands/hugo_list_drafts.md +++ b/content/en/commands/hugo_list_drafts.md @@ -12,7 +12,7 @@ List all drafts List all of the drafts in your content directory. ``` -hugo list drafts [flags] +hugo list drafts [flags] [args] ``` ### Options @@ -28,7 +28,9 @@ hugo list drafts [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_expired.md b/content/en/commands/hugo_list_expired.md index 89c10d501..3feae5640 100644 --- a/content/en/commands/hugo_list_expired.md +++ b/content/en/commands/hugo_list_expired.md @@ -12,7 +12,7 @@ List all posts already expired List all of the posts in your content directory which has already expired. ``` -hugo list expired [flags] +hugo list expired [flags] [args] ``` ### Options @@ -28,7 +28,9 @@ hugo list expired [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_list_future.md b/content/en/commands/hugo_list_future.md index ca15b7673..5b331b90b 100644 --- a/content/en/commands/hugo_list_future.md +++ b/content/en/commands/hugo_list_future.md @@ -12,7 +12,7 @@ List all posts dated in the future List all of the posts in your content directory which will be posted in the future. ``` -hugo list future [flags] +hugo list future [flags] [args] ``` ### Options @@ -28,7 +28,9 @@ hugo list future [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod.md b/content/en/commands/hugo_mod.md index 1df6df78e..8621f30dd 100644 --- a/content/en/commands/hugo_mod.md +++ b/content/en/commands/hugo_mod.md @@ -10,7 +10,6 @@ Various Hugo Modules helpers. ### Synopsis Various helpers to help manage the modules in your project's dependency graph. - Most operations here requires a Go version installed on your system (>= Go 1.12) and the relevant VCS client (typically Git). This is not needed if you only operate on modules inside /themes or if you have vendored them via "hugo mod vendor". @@ -26,53 +25,27 @@ See https://gohugo.io/hugo-modules/ for more information. ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - -e, --environment string build environment - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for mod - --ignoreCache ignores the cache directory - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --panicOnWarning panic on first WARNING log - --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - -s, --source string filesystem path to read files relative from - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) - --themesDir string filesystem path to themes directory - --trace file write trace to file (not useful in general) + -h, --help help for mod ``` ### 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 diff --git a/content/en/commands/hugo_mod_clean.md b/content/en/commands/hugo_mod_clean.md index b13b7c020..922fab2ab 100644 --- a/content/en/commands/hugo_mod_clean.md +++ b/content/en/commands/hugo_mod_clean.md @@ -11,14 +11,8 @@ Delete the Hugo Module cache for the current project. Delete the Hugo Module cache for the current project. -Note that after you run this command, all of your dependencies will be re-downloaded next time you run "hugo". - -Also note that if you configure a positive maxAge for the "modules" file cache, it will also be cleaned as part of "hugo --gc". - - - ``` -hugo mod clean [flags] +hugo mod clean [flags] [args] ``` ### Options @@ -36,7 +30,9 @@ hugo mod clean [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_get.md b/content/en/commands/hugo_mod_get.md index 54eaa74de..d0d0f85d3 100644 --- a/content/en/commands/hugo_mod_get.md +++ b/content/en/commands/hugo_mod_get.md @@ -38,7 +38,7 @@ See https://gohugo.io/hugo-modules/ for more information. ``` -hugo mod get [flags] +hugo mod get [flags] [args] ``` ### Options @@ -54,7 +54,9 @@ hugo mod get [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_graph.md b/content/en/commands/hugo_mod_graph.md index ba8898a69..da72a2a31 100644 --- a/content/en/commands/hugo_mod_graph.md +++ b/content/en/commands/hugo_mod_graph.md @@ -14,13 +14,14 @@ Note that for vendored modules, that is the version listed and not the one from ``` -hugo mod graph [flags] +hugo mod graph [flags] [args] ``` ### Options ``` - -h, --help help for graph + --clean delete module cache for dependencies that fail verification + -h, --help help for graph ``` ### Options inherited from parent commands @@ -30,7 +31,9 @@ hugo mod graph [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_init.md b/content/en/commands/hugo_mod_init.md index 21aacf131..7d5f77aa7 100644 --- a/content/en/commands/hugo_mod_init.md +++ b/content/en/commands/hugo_mod_init.md @@ -10,16 +10,16 @@ Initialize this project as a Hugo Module. ### 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 @@ -35,7 +35,9 @@ hugo mod init [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_npm.md b/content/en/commands/hugo_mod_npm.md index 0a9a43869..12ec71b77 100644 --- a/content/en/commands/hugo_mod_npm.md +++ b/content/en/commands/hugo_mod_npm.md @@ -12,7 +12,7 @@ Various npm helpers. Various npm (Node package manager) helpers. ``` -hugo mod npm [flags] +hugo mod npm [command] [flags] ``` ### Options @@ -28,7 +28,9 @@ hugo mod npm [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_npm_pack.md b/content/en/commands/hugo_mod_npm_pack.md index 597b039de..b923db82c 100644 --- a/content/en/commands/hugo_mod_npm_pack.md +++ b/content/en/commands/hugo_mod_npm_pack.md @@ -22,7 +22,7 @@ so this may/will change in future versions of Hugo. ``` -hugo mod npm pack [flags] +hugo mod npm pack [flags] [args] ``` ### Options @@ -38,7 +38,9 @@ hugo mod npm pack [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_tidy.md b/content/en/commands/hugo_mod_tidy.md index 68279cf9b..63cb52ca6 100644 --- a/content/en/commands/hugo_mod_tidy.md +++ b/content/en/commands/hugo_mod_tidy.md @@ -8,7 +8,7 @@ url: /commands/hugo_mod_tidy/ Remove unused entries in go.mod and go.sum. ``` -hugo mod tidy [flags] +hugo mod tidy [flags] [args] ``` ### Options @@ -24,7 +24,9 @@ hugo mod tidy [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_vendor.md b/content/en/commands/hugo_mod_vendor.md index 1dab295ca..9d9943c8a 100644 --- a/content/en/commands/hugo_mod_vendor.md +++ b/content/en/commands/hugo_mod_vendor.md @@ -10,12 +10,11 @@ Vendor all module dependencies into the _vendor directory. ### Synopsis Vendor all module dependencies into the _vendor directory. - -If a module is vendored, that is where Hugo will look for it's dependencies. - + If a module is vendored, that is where Hugo will look for it's dependencies. + ``` -hugo mod vendor [flags] +hugo mod vendor [flags] [args] ``` ### Options @@ -31,7 +30,9 @@ hugo mod vendor [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_mod_verify.md b/content/en/commands/hugo_mod_verify.md index 7ffab453e..dd41f29fd 100644 --- a/content/en/commands/hugo_mod_verify.md +++ b/content/en/commands/hugo_mod_verify.md @@ -11,9 +11,8 @@ Verify dependencies. Verify checks that the dependencies of the current module, which are stored in a local downloaded source cache, have not been modified since being downloaded. - ``` -hugo mod verify [flags] +hugo mod verify [flags] [args] ``` ### Options @@ -30,7 +29,9 @@ hugo mod verify [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/commands/hugo_new.md b/content/en/commands/hugo_new.md index e0f58247b..dd170eee5 100644 --- a/content/en/commands/hugo_new.md +++ b/content/en/commands/hugo_new.md @@ -19,67 +19,39 @@ If archetypes are provided in your theme or site, they will be used. Ensure you run this within the root directory of your site. ``` -hugo new [path] [flags] +hugo new [command] [flags] ``` ### Options ``` - -b, --baseURL string hostname (and path) to the root, e.g. https://spf13.com/ - -D, --buildDrafts include content marked as draft - -E, --buildExpired include expired content - -F, --buildFuture include content with publishdate in the future - --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ - --cleanDestinationDir remove files from destination not found in static directories - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableKinds strings disable different kind of pages (home, RSS etc.) - --editor string edit new content with this editor, if provided - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - -e, --environment string build environment - -f, --force overwrite file if it already exists - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for new - --ignoreCache ignores the cache directory - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -k, --kind string content type to create - -l, --layoutDir string filesystem path to layout directory - --minify minify any supported output format (HTML, XML etc.) - --noBuildLock don't create .hugo_build.lock file - --noChmod don't sync permission mode of files - --noTimes don't sync modification time of files - --panicOnWarning panic on first WARNING log - --poll string set this to a poll interval, e.g --poll 700ms, to use a poll based approach to watch for file system changes - --printI18nWarnings print missing translations - --printMemoryUsage print memory usage to screen at intervals - --printPathWarnings print warnings on duplicate target paths etc. - --printUnusedTemplates print warnings on unused templates. - -s, --source string filesystem path to read files relative from - --templateMetrics display metrics about template executions - --templateMetricsHints calculate some improvement hints when combined with --templateMetrics - -t, --theme strings themes to use (located in /themes/THEMENAME/) - --themesDir string filesystem path to themes directory - --trace file write trace to file (not useful in general) + -h, --help help for new ``` ### 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](/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) diff --git a/content/en/commands/hugo_new_content.md b/content/en/commands/hugo_new_content.md new file mode 100644 index 000000000..e26fa9459 --- /dev/null +++ b/content/en/commands/hugo_new_content.md @@ -0,0 +1,57 @@ +--- +title: "hugo new content" +slug: hugo_new_content +url: /commands/hugo_new_content/ +--- +## hugo new content + +Create new content for your site + +### Synopsis + +Create a new content file and automatically set the date and title. + It will guess which kind of file to create based on the path provided. + + You can also specify the kind with `-k KIND`. + + If archetypes are provided in your theme or site, they will be used. + + Ensure you run this within the root directory of your site. + +``` +hugo new content [path] [flags] +``` + +### Options + +``` + --editor string edit new content with this editor, if provided + -f, --force overwrite file if it already exists + -h, --help help for content + -k, --kind string content type to create +``` + +### Options inherited from parent commands + +``` + --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 + --config string config file (default is hugo.yaml|json|toml) + --configDir string config dir (default "config") + --debug debug output + -d, --destination string filesystem path to write files to + -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") + --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --themesDir string filesystem path to themes directory + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO + +* [hugo new](/commands/hugo_new/) - Create new content for your site + diff --git a/content/en/commands/hugo_new_site.md b/content/en/commands/hugo_new_site.md index e594a9979..803127de3 100644 --- a/content/en/commands/hugo_new_site.md +++ b/content/en/commands/hugo_new_site.md @@ -20,27 +20,28 @@ hugo new site [path] [flags] ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - --force init inside non-empty directory - -f, --format string config file format (default "toml") - -h, --help help for site - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + --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 diff --git a/content/en/commands/hugo_new_theme.md b/content/en/commands/hugo_new_theme.md index 48c374d98..b1f1ea3ee 100644 --- a/content/en/commands/hugo_new_theme.md +++ b/content/en/commands/hugo_new_theme.md @@ -5,41 +5,42 @@ url: /commands/hugo_new_theme/ --- ## hugo new theme -Create a new theme +Create a new site (skeleton) ### Synopsis -Create a new theme (skeleton) called [name] in ./themes. -New theme is a skeleton. Please add content to the touched files. Add your -name to the copyright line in the license and adjust the theme.toml file -as you see fit. +Create a new site in the provided directory. +The new site will have the correct structure, but no content or theme yet. +Use `hugo new [contentPath]` to create new content. ``` -hugo new theme [name] [flags] +hugo new theme [path] [flags] ``` ### Options ``` - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -e, --environment string build environment - -h, --help help for theme - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -s, --source string filesystem path to read files relative from - --themesDir string filesystem path to themes directory + -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 diff --git a/content/en/commands/hugo_server.md b/content/en/commands/hugo_server.md index f80bd496e..657a4eee4 100644 --- a/content/en/commands/hugo_server.md +++ b/content/en/commands/hugo_server.md @@ -23,73 +23,74 @@ and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly. ``` -hugo server [flags] +hugo server [flags] [args] ``` ### Options ``` - --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 - --clock string set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00 - -c, --contentDir string filesystem path to content directory - -d, --destination string filesystem path to write files to - --disableBrowserError do not show build errors in the browser - --disableFastRender enables full re-renders on changes - --disableKinds strings disable different kind of pages (home, RSS etc.) - --disableLiveReload watch without enabling live browser reload on rebuild - --enableGitInfo add Git revision, date, author, and CODEOWNERS info to the pages - -e, --environment string build environment - --forceSyncStatic copy all files when static is changed. - --gc enable to run some cleanup tasks (remove unused cache files) after the build - -h, --help help for server - --ignoreCache ignores the cache directory - --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern - -l, --layoutDir string filesystem path to layout directory - --liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1) - --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") - --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) - -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) + --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 ``` - --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 diff --git a/content/en/commands/hugo_version.md b/content/en/commands/hugo_version.md index bdef5bbd4..35b720153 100644 --- a/content/en/commands/hugo_version.md +++ b/content/en/commands/hugo_version.md @@ -5,14 +5,14 @@ url: /commands/hugo_version/ --- ## hugo version -Print the version number of Hugo +Print Hugo version and environment info ### Synopsis -All software has versions. This is Hugo's. +Print Hugo version and environment info. This is useful in Hugo bug reports. ``` -hugo version [flags] +hugo version [flags] [args] ``` ### Options @@ -28,7 +28,9 @@ hugo version [flags] --config string config file (default is hugo.yaml|json|toml) --configDir string config dir (default "config") --debug debug output + -d, --destination string filesystem path to write files to -e, --environment string build environment + --format string preferred file format (toml, yaml or json) (default "toml") --ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern --log enable Logging --logFile string log File path (if set, logging enabled automatically) diff --git a/content/en/content-management/cross-references.md b/content/en/content-management/cross-references.md index 00fb2d973..a2b3f8e1c 100644 --- a/content/en/content-management/cross-references.md +++ b/content/en/content-management/cross-references.md @@ -139,7 +139,7 @@ produces this HTML: ## Ref and RelRef Configuration -The behavior can, since Hugo 0.45, be configured in `config.toml`: +The behavior can, since Hugo 0.45, be configured in `hugo.toml`: refLinksErrorLevel ("ERROR") : When using `ref` or `relref` to resolve page links and a link cannot resolved, it will be logged with this log level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`). diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 78d3323dd..062288320 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -135,7 +135,7 @@ weight : Field name of the *plural* form of the index. See `tags` and `categories` in the above front matter examples. *Note that the plural form of user-defined taxonomies cannot be the same as any of the predefined front matter variables.* {{% note %}} -If neither `slug` nor `url` is present and [permalinks are not configured otherwise in your site `config` file](/content-management/urls/#permalinks), Hugo will use the filename of your content to create the output URL. See [Content Organization](/content-management/organization) for an explanation of paths in Hugo and [URL Management](/content-management/urls/) for ways to customize Hugo's default behaviors. +If neither `slug` nor `url` is present and [permalinks are not configured otherwise in your site configuration file](/content-management/urls/#permalinks), Hugo will use the filename of your content to create the output URL. See [Content Organization](/content-management/organization) for an explanation of paths in Hugo and [URL Management](/content-management/urls/) for ways to customize Hugo's default behaviors. {{% /note %}} ### User-Defined diff --git a/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index 0043f97b0..3d70951b3 100644 --- a/content/en/content-management/image-processing/index.md +++ b/content/en/content-management/image-processing/index.md @@ -384,7 +384,7 @@ Note the self-closing shortcode syntax above. You may call the `imgproc` shortco Define an `imaging` section in your site configuration to set the default [image processing options](#image-processing-options). -{{< code-toggle file="config" copy=true >}} +{{< code-toggle file="hugo" copy=true >}} [imaging] resampleFilter = "Box" quality = 75 @@ -412,7 +412,7 @@ resampleFilter Define an `imaging.exif` section in your site configuration to control the availability of Exif data. -{{< code-toggle file="config" copy=true >}} +{{< code-toggle file="hugo" copy=true >}} [imaging.exif] includeFields = "" excludeFields = "" diff --git a/content/en/content-management/menus.md b/content/en/content-management/menus.md index 369938aba..07bf41669 100644 --- a/content/en/content-management/menus.md +++ b/content/en/content-management/menus.md @@ -36,7 +36,7 @@ Although you can use these methods in combination when defining a menu, the menu To automatically define menu entries for each top-level section of your site, enable the section pages menu in your site configuration. -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} sectionPagesMenu = "main" {{< /code-toggle >}} @@ -111,7 +111,7 @@ Access the entry with `site.Menus.main` in your templates. See [menu templates] To define entries for the "main" menu: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [[menu.main]] name = 'Home' pageRef = '/' @@ -132,7 +132,7 @@ This creates a menu structure that you can access with `site.Menus.main` in your To define entries for the "footer" menu: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [[menu.footer]] name = 'Terms' pageRef = '/terms' @@ -177,7 +177,7 @@ url This nested menu demonstrates some of the available properties: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [[menu.main]] name = 'Products' pageRef = '/products' diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index f1f25086a..71adc214d 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -21,7 +21,7 @@ Also See [Hugo Multilingual Part 1: Content translation]. The following is an example of a site configuration for a multilingual Hugo project: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} defaultContentLanguage = "en" copyright = "Everything is mine" @@ -73,10 +73,10 @@ Only the obvious non-global options can be overridden per language. Examples of {{< new-in "0.112.0" >}} -In version `0.112.0` of Hugo we did a major we consolidated all configuration options, but also improved how the languages and their params gets merged with the main configuration. But while testing this on Hugo sites out there, we got some error reports. +In Hugo `v0.112.0` we consolidated all configuration options, and improved how the languages and their parameters are merged with the main configuration. But while testing this on Hugo sites out there, we received some error reports and reverted some of the changes in favor of deprecation warnings: 1. `site.Language.Params` is deprecated. Use `site.Params` directly. -1. The `params` sections on site and language is the only place to put custom user parameters, and `site.Params` will only contain these user defined parameters (see example below). +1. Adding custom params to the top level language config is deprecated, add all of these below `[params]`, see `color` in the example below. ```toml title = "My blog" @@ -90,7 +90,7 @@ languageCode = "sv" color = "blue" ``` -In the example above, all the settings exept the `color` below `params` maps to predefined configuration options in Hguo for the site and its language, and should be accessed via the documented accessors: +In the example above, all settings except `color` below `params` map to predefined configuration options in Hugo for the site and its language, and should be accessed via the documented accessors: ``` {{ site.Title }} @@ -102,7 +102,7 @@ In the example above, all the settings exept the `color` below `params` maps to You can disable one or more languages. This can be useful when working on a new translation. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} disableLanguages = ["fr", "ja"] {{< /code-toggle >}} @@ -114,7 +114,7 @@ We kept this as a standalone setting to make it easier to set via [OS environmen HUGO_DISABLELANGUAGES="fr ja" hugo ``` -If you have already a list of disabled languages in `config.toml`, you can enable them in development like this: +If you have already a list of disabled languages in `hugo.toml`, you can enable them in development like this: ```bash HUGO_DISABLELANGUAGES=" " hugo server @@ -132,7 +132,7 @@ If a `baseURL` is set on the `language` level, then all languages must have one Example: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [languages] [languages.fr] baseURL = "https://example.fr" @@ -194,7 +194,7 @@ If a file has no language code, it will be assigned the default language. This system uses different content directories for each of the languages. Each language's content directory is set using the `contentDir` param. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} languages: en: weight: 10 @@ -400,7 +400,7 @@ In case you need to pass a custom data: (`(dict "Count" numeric_value_only)` is The following localization examples assume your site's primary language is English, with translations to French and German. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} defaultContentLanguage = 'en' [languages] @@ -522,7 +522,7 @@ The `identifier` depends on how you define menu entries: For example, if you define menu entries in site configuration: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [[menu.main]] identifier = 'products' name = 'Products' @@ -551,7 +551,7 @@ services = 'Leistungen' For example: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [languages.de] languageCode = 'de-DE' languageName = 'Deutsch' diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index 4bbd159be..54494c2e1 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -78,7 +78,7 @@ MediaType.MainType : The main type of the resource's MIME type. For example, a file of MIME type `application/pdf` has for MainType `application`. MediaType.SubType -: The subtype of the resource's MIME type. For example, a file of MIME type `application/pdf` has for SubType `pdf`. Note that this is not the same as the file extension - PowerPoint files have a subtype of `vnd.mspowerpoint`. +: The subtype of the resource's MIME type. For example, a file of MIME type `application/pdf` has for SubType `pdf`. Note that this is not the same as the file extension. For example, Microsoft PowerPoint files (`.ppt`) have a subtype of `vnd.ms-powerpoint`. MediaType.Suffixes : A slice of possible suffixes for the resource's MIME type. diff --git a/content/en/content-management/related.md b/content/en/content-management/related.md index 823e3035c..e80c0f06b 100644 --- a/content/en/content-management/related.md +++ b/content/en/content-management/related.md @@ -66,7 +66,7 @@ We improved and simplified this feature in Hugo 0.111.0. Before this we had 3 di Hugo can index the headings in your content and use this to find related content. You can enable this by adding a index of type `fragments` to your `related` configuration: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [related] threshold = 20 includeNewer = true @@ -113,7 +113,7 @@ Hugo provides a sensible default configuration of Related Content, but you can f Without any `related` configuration set on the project, Hugo's Related Content methods will use the following. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} related: threshold: 80 includeNewer: false diff --git a/content/en/content-management/shortcodes.md b/content/en/content-management/shortcodes.md index f91adc227..b2c98fc65 100644 --- a/content/en/content-management/shortcodes.md +++ b/content/en/content-management/shortcodes.md @@ -116,6 +116,9 @@ height width : `width` attribute of the image. +loading +: `loading` attribute of the image. + attr : Image attribution text. Markdown within the value of `attr` will be rendered. @@ -222,7 +225,7 @@ You must obtain an Access Token to use the `instagram` shortcode. If your site configuration is private: -{{< code-toggle file=config copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [services.instagram] accessToken = 'xxx' {{< /code-toggle >}} diff --git a/content/en/content-management/static-files.md b/content/en/content-management/static-files.md index 6bff7fd6f..ddc35da36 100644 --- a/content/en/content-management/static-files.md +++ b/content/en/content-management/static-files.md @@ -28,7 +28,7 @@ This union filesystem will be served from your site root. So a file Here's an example of setting `staticDir` and `staticDir2` for a multi-language site: -{{< code-toggle copy=false file="config" >}} +{{< code-toggle copy=false file="hugo" >}} staticDir = ["static1", "static2"] [languages] diff --git a/content/en/content-management/taxonomies.md b/content/en/content-management/taxonomies.md index fe42a0667..a532e1873 100644 --- a/content/en/content-management/taxonomies.md +++ b/content/en/content-management/taxonomies.md @@ -82,7 +82,7 @@ Hugo natively supports taxonomies. Without adding a single line to your [site config][config] file, Hugo will automatically create taxonomies for `tags` and `categories`. That would be the same as manually [configuring your taxonomies](#configure-taxonomies) as below: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [taxonomies] tag = "tags" category = "categories" @@ -90,7 +90,7 @@ Without adding a single line to your [site config][config] file, Hugo will autom If you do not want Hugo to create any taxonomies, set `disableKinds` in your [site config][config] to the following: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} disableKinds = ["taxonomy","term"] {{}} @@ -113,7 +113,7 @@ Custom taxonomies other than the [defaults](#default-taxonomies) must be defined While adding custom taxonomies, you need to put in the default taxonomies too, _if you want to keep them_. {{% /note %}} -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [taxonomies] tag = "tags" category = "categories" @@ -124,7 +124,7 @@ While adding custom taxonomies, you need to put in the default taxonomies too, _ If you want to have just the default `tags` taxonomy, and remove the `categories` taxonomy for your site, you can do so by modifying the `taxonomies` value in your [site config][config]. -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [taxonomies] tag = "tags" {{}} diff --git a/content/en/content-management/urls.md b/content/en/content-management/urls.md index c65d6c15a..48de64966 100644 --- a/content/en/content-management/urls.md +++ b/content/en/content-management/urls.md @@ -110,7 +110,7 @@ content/ Create a date-based hierarchy, recursively, for regular pages within the `posts` section: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [permalinks] posts = '/posts/:year/:month/:title/' {{< /code-toggle >}} @@ -133,7 +133,7 @@ public/ To create a date-based hierarchy for regular pages in the content root: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [permalinks] '/' = '/:year/:month/:title/' {{< /code-toggle >}} @@ -144,7 +144,7 @@ A URL pattern defined for the content root is not recursive. Use the same approach with taxonomies. For example, to omit the taxonomy segment of the URL: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [permalinks] 'tags' = '/:title/' {{< /code-toggle >}} @@ -198,7 +198,7 @@ For time-related values, you can also use the layout string components defined i [time package]: https://pkg.go.dev/time#pkg-constants -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} permalinks: posts: /:06/:1/:2/:title/ {{< /code-toggle >}} @@ -214,7 +214,7 @@ pretty|content/about.md|`https://example.org/about/` By default, Hugo produces pretty URLs. To generate ugly URLs, change your site configuration: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} uglyURLs = true {{< /code-toggle >}} @@ -241,7 +241,7 @@ This is an imperfect, brute force approach that can affect content as well as HT To enable: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} canonifyURLs = true {{< /code-toggle >}} @@ -264,7 +264,7 @@ This is an imperfect, brute force approach that can affect content as well as HT To enable: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} relativeURLs = true {{< /code-toggle >}} diff --git a/content/en/contribute/documentation.md b/content/en/contribute/documentation.md index b1fed4cb2..4583f7cf4 100644 --- a/content/en/contribute/documentation.md +++ b/content/en/contribute/documentation.md @@ -128,7 +128,7 @@ fm #### Site configuration example ```text -{{}} +{{}} baseURL = 'https://example.org' languageCode = 'en-US' title = "Example Site" @@ -137,7 +137,7 @@ title = "Example Site" Rendered: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} baseURL = 'https://example.org' languageCode = 'en-US' title = "Example Site" diff --git a/content/en/functions/hasPrefix.md b/content/en/functions/hasPrefix.md new file mode 100644 index 000000000..cf29315e2 --- /dev/null +++ b/content/en/functions/hasPrefix.md @@ -0,0 +1,21 @@ +--- +title: hasprefix +linktitle: hasPrefix +description: Tests whether a string begins with prefix. +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [strings] +signature: ["hasPrefix STRING PREFIX"] +workson: [] +hugoversion: +relatedfuncs: [hasSuffix] +deprecated: false +aliases: [] +--- + +* `{{ hasPrefix "Hugo" "Hu" }}` → true diff --git a/content/en/functions/hasSuffix.md b/content/en/functions/hasSuffix.md new file mode 100644 index 000000000..9906cc2c3 --- /dev/null +++ b/content/en/functions/hasSuffix.md @@ -0,0 +1,21 @@ +--- +title: hassuffix +linktitle: hasSuffix +description: Tests whether a string ends with suffix. +date: 2023-03-01 +publishdate: 2023-03-01 +lastmod: 2023-03-01 +categories: [functions] +menu: +docs: +parent: "functions" +keywords: [strings] +signature: ["hasSuffix STRING SUFFIX"] +workson: [] +hugoversion: +relatedfuncs: [hasPrefix] +deprecated: false +aliases: [] +--- + +* `{{ hasSuffix "Hugo" "go" }}` → true \ No newline at end of file diff --git a/content/en/functions/hugo.md b/content/en/functions/hugo.md index 998c71c37..78d658c66 100644 --- a/content/en/functions/hugo.md +++ b/content/en/functions/hugo.md @@ -13,32 +13,35 @@ relatedfuncs: [] `hugo` returns an instance that contains the following functions: -hugo.Generator -: `` tag for the version of Hugo that generated the site. `hugo.Generator` outputs a *complete* HTML tag; e.g. `` +`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., ``). -hugo.BuildDate -: the compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00` +`hugo.GoVersion` +: (`string`) The Go version used to compile the Hugo binary (e.g., `go1.20.4`). {{< new-in "0.101.0" >}} -hugo.IsExtended -: whether this is the extended Hugo binary. +`hugo.IsExtended` +: (`bool`) Returns `true` if the Hugo binary is the extended version. -hugo.IsProduction -: returns true if `hugo.Environment` is set to the production environment +`hugo.IsProduction` +: (`bool`) Returns `true` if `hugo.Environment` is set to the production environment. -hugo.Deps -: See [hugo.Deps](#hugodeps) +`hugo.Version` +: (`hugo.VersionString`) The current version of the Hugo binary (e.g., `0.112.1`). + +`hugo.WorkingDir` +: (`string`) The project working directory (e.g., `/home/user/projects/my-hugo-site`). {{< new-in "0.112.0" >}} ## hugo.Deps @@ -48,28 +51,28 @@ hugo.Deps Each dependency contains: -Path (string) -: Returns the path to this module. This will either be the module path, e.g. "github.com/gohugoio/myshortcodes", or the path below your /theme folder, e.g. "mytheme". - -Version (string) -: The module version. - -Vendor (bool) -: Whether this dependency is vendored. - -Time (time.Time) -: Time version was created. - Owner -: In the dependency tree, this is the first module that defines this module as a dependency. +: (`*hugo.Dependency`) In the dependency tree, this is the first module that defines this module as a dependency (e.g., `github.com/gohugoio/hugo-mod-bootstrap-scss/v5`). -Replace (*Dependency) -: Replaced by this dependency. +Path +: (`string`) The module path or the path below your `themes` directory (e.g., `github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2`). + +Replace +: (`*hugo.Dependency`) Replaced by this dependency. + +Time +: (`time.Time`) The time that the version was created (e.g., `2022-02-13 15:11:28 +0000 UTC`). + +Vendor +: (`bool`) Returns `true` if the dependency is vendored. + +Version +: (`string`) The module version (e.g., `v2.21100.20000`). An example table listing the dependencies: ```html -

Dependencies

+

Dependencies

diff --git a/content/en/functions/math.md b/content/en/functions/math.md index e84bb5f1f..c36b8ea0b 100644 --- a/content/en/functions/math.md +++ b/content/en/functions/math.md @@ -23,6 +23,7 @@ relatedfuncs: [] | | *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` | diff --git a/content/en/functions/param.md b/content/en/functions/param.md index c01bf4a91..45ef4434c 100644 --- a/content/en/functions/param.md +++ b/content/en/functions/param.md @@ -17,7 +17,7 @@ For example, to show a table of contents on every page, but allow authors to hid **Configuration** -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [params] display_toc = true {{< /code-toggle >}} diff --git a/content/en/functions/safeHTML.md b/content/en/functions/safeHTML.md index 182633e46..4e74b44d4 100644 --- a/content/en/functions/safeHTML.md +++ b/content/en/functions/safeHTML.md @@ -12,9 +12,9 @@ relatedfuncs: [] It should not be used for HTML from a third-party, or HTML with unclosed tags or comments. -Given a site-wide [`config.toml`][config] with the following `copyright` value: +Given a site-wide [`hugo.toml`][config] with the following `copyright` value: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} copyright = "© 2015 Jane Doe. Some rights reserved." {{< /code-toggle >}} diff --git a/content/en/functions/safeHTMLAttr.md b/content/en/functions/safeHTMLAttr.md index 8d1d7efbc..ac7f32d7a 100644 --- a/content/en/functions/safeHTMLAttr.md +++ b/content/en/functions/safeHTMLAttr.md @@ -12,7 +12,7 @@ relatedfuncs: [] Given a site configuration that contains this menu entry: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [[menu.main]] name = "IRC" url = "irc://irc.freenode.net/#golang" diff --git a/content/en/functions/safeURL.md b/content/en/functions/safeURL.md index 4d517bd1e..b21de4953 100644 --- a/content/en/functions/safeURL.md +++ b/content/en/functions/safeURL.md @@ -14,9 +14,9 @@ relatedfuncs: [] Without `safeURL`, only the URI schemes `http:`, `https:` and `mailto:` are considered safe by Go templates. If any other URI schemes (e.g., `irc:` and `javascript:`) are detected, the whole URL will be replaced with `#ZgotmplZ`. This is to "defang" any potential attack in the URL by rendering it useless. -The following examples use a [site `config.toml`][configuration] with the following [menu entry][menus]: +The following examples use a [site `hugo.toml`][configuration] with the following [menu entry][menus]: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [[menu.main]] name = "IRC: #golang at freenode" url = "irc://irc.freenode.net/#golang" diff --git a/content/en/functions/sort.md b/content/en/functions/sort.md index fc147c9fb..aa15f5cd6 100644 --- a/content/en/functions/sort.md +++ b/content/en/functions/sort.md @@ -18,7 +18,7 @@ The `ORDER` may be either `asc` (ascending) or `desc` (descending). The default The examples below assume this site configuration: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [params] grades = ['b','a','c'] {{< /code-toggle >}} @@ -48,7 +48,7 @@ In the example above, `value` is the `KEY` representing the value of the slice e The examples below assume this site configuration: -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [params.authors.a] firstName = "Marius" lastName = "Pontmercy" diff --git a/content/en/functions/urls.JoinPath.md b/content/en/functions/urls.JoinPath.md new file mode 100644 index 000000000..f11632367 --- /dev/null +++ b/content/en/functions/urls.JoinPath.md @@ -0,0 +1,25 @@ +--- +title: urls.JoinPath +description: Joins the provided elements into a URL string and cleans the result of any ./ or ../ elements. If the argument list is empty, JoinPath returns an empty string. +categories: [functions] +menu: + docs: + parent: functions +keywords: [urls,path,join] +signature: ["urls.JoinPath ELEMENT..."] +--- + +```go-html-template +{{ urls.JoinPath }} → "" +{{ urls.JoinPath "" }} → "/" +{{ urls.JoinPath "a" }} → "a" +{{ urls.JoinPath "a" "b" }} → "a/b" +{{ urls.JoinPath "/a" "b" }} → "/a/b" +{{ urls.JoinPath "https://example.org" "b" }} → "https://example.org/b" + +{{ urls.JoinPath (slice "a" "b") }} → "a/b" +``` + +Unlike the [`path.Join`] function, `urls.JoinPath` retains consecutive leading slashes. + +[`path.Join`]: /functions/path.join/ diff --git a/content/en/functions/where.md b/content/en/functions/where.md index 49882b807..871d04e9b 100644 --- a/content/en/functions/where.md +++ b/content/en/functions/where.md @@ -158,7 +158,7 @@ will default to the *section with the most pages*. The user can override the default: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [params] mainSections = ["blog", "docs"] {{< /code-toggle >}} diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index e47d3c942..53b444bb6 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -15,8 +15,8 @@ toc: true ## Configuration File -Hugo uses the `config.toml`, `config.yaml`, or `config.json` (if found in the -site root) as the default site config file. +Hugo uses the `hugo.toml`, `hugo.yaml`, or `hugo.json` (if found in the +site root) as the default site configuration file. The user can choose to override that default with one or more site config files using the command-line `--config` switch. @@ -45,7 +45,7 @@ In addition to using a single site config file, one can use the `configDir` dire - Each file represents a configuration root object, such as `params.toml` for `[Params]`, `menu(s).toml` for `[Menu]`, `languages.toml` for `[Languages]` etc... - Each file's content must be top-level, for example: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [Params] foo = "bar" {{< /code-toggle >}} @@ -61,35 +61,35 @@ foo = "bar" ```txt ├── config │ ├── _default -│ │ ├── config.toml +│ │ ├── hugo.toml │ │ ├── languages.toml │ │ ├── menus.en.toml │ │ ├── menus.zh.toml │ │ └── params.toml │ ├── production -│ │ ├── config.toml +│ │ ├── hugo.toml │ │ └── params.toml │ └── staging -│ ├── config.toml +│ ├── hugo.toml │ └── params.toml ``` Considering the structure above, when running `hugo --environment staging`, Hugo will use every setting from `config/_default` and merge `staging`'s on top of those. -Let's take an example to understand this better. Let's say you are using Google Analytics for your website. This requires you to specify `googleAnalytics = "G-XXXXXXXX"` in `config.toml`. Now consider the following scenario: +Let's take an example to understand this better. Let's say you are using Google Analytics for your website. This requires you to specify `googleAnalytics = "G-XXXXXXXX"` in `hugo.toml`. Now consider the following scenario: - You don't want the Analytics code to be loaded in development i.e. in your `localhost` - You want to use separate googleAnalytics IDs for your production & staging environments (say): - `G-PPPPPPPP` for production - `G-SSSSSSSS` for staging -This is how you need to configure your `config.toml` files considering the above scenario: -1. In `_default/config.toml` you don't need to mention `googleAnalytics` parameter at all. This ensures that no Google Analytics code is loaded in your development server i.e. when you run `hugo server`. This works since, by default Hugo sets `Environment=development` when you run `hugo server` which uses the config files from `_default` folder -2. In `production/config.toml` you just need to have one line: +This is how you need to configure your `hugo.toml` files considering the above scenario: +1. In `_default/hugo.toml` you don't need to mention `googleAnalytics` parameter at all. This ensures that no Google Analytics code is loaded in your development server i.e. when you run `hugo server`. This works since, by default Hugo sets `Environment=development` when you run `hugo server` which uses the config files from `_default` folder +2. In `production/hugo.toml` you just need to have one line: ```googleAnalytics = "G-PPPPPPPP"``` - You don't need to mention all other parameters like `title`, `baseURL`, `theme` etc. again in this config file. You need to mention only those parameters which are different or new for the production environment. This is due to the fact that Hugo is going to __merge__ this on top of `_default/config.toml`. Now when you run `hugo` (build command), by default hugo sets `Environment=production`, so the `G-PPPPPPPP` analytics code will be there in your production website -3. Similarly in `staging/config.toml` you just need to have one line: + You don't need to mention all other parameters like `title`, `baseURL`, `theme` etc. again in this config file. You need to mention only those parameters which are different or new for the production environment. This is due to the fact that Hugo is going to __merge__ this on top of `_default/hugo.toml`. Now when you run `hugo` (build command), by default hugo sets `Environment=production`, so the `G-PPPPPPPP` analytics code will be there in your production website +3. Similarly in `staging/hugo.toml` you just need to have one line: ```googleAnalytics = "G-SSSSSSSS"``` @@ -378,7 +378,7 @@ The directory to where Hugo will write the final static site (the HTML files etc ### related -: See [Related Content](/content-management/related/#configure-related-content). +See [Related Content](/content-management/related/#configure-related-content). ### relativeURLs @@ -494,7 +494,7 @@ enableemoji: true The `build` configuration section contains global build-related configuration options. -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [build] useResourceCacheWhen="fallback" writeStats = false @@ -518,7 +518,7 @@ noJSConfigInAssets This is only relevant when running `hugo server`, and it allows to set HTTP headers during development, which allows you to test out your Content Security Policy and similar. The configuration format matches [Netlify's](https://docs.netlify.com/routing/headers/#syntax-for-the-netlify-configuration-file) with slightly more powerful [Glob matching](https://github.com/gobwas/glob): -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [server] [[server.headers]] for = "/**" @@ -592,18 +592,18 @@ HUGO_NUMWORKERMULTIPLIER Similar to the template [lookup order], Hugo has a default set of rules for searching for a configuration file in the root of your website's source directory as a default behavior: -1. `./config.toml` -2. `./config.yaml` -3. `./config.json` +1. `./hugo.toml` +2. `./hugo.yaml` +3. `./hugo.json` -In your `config` file, you can direct Hugo as to how you want your website rendered, control your website's menus, and arbitrarily define site-wide parameters specific to your project. +In your configuration file, you can direct Hugo as to how you want your website rendered, control your website's menus, and arbitrarily define site-wide parameters specific to your project. ## Example Configuration The following is a typical example of a configuration file. The values nested under `params:` will populate the [`.Site.Params`] variable for use in [templates]: -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} baseURL: "https://yoursite.example.com/" title: "My Hugo Site" permalinks: @@ -650,13 +650,13 @@ To exclude specific files from the `content`, `data`, and `i18n` directories whe To ignore files ending with `.foo` or `.boo`: -{{< code-toggle copy=false >}} +{{< code-toggle copy=false file="hugo" >}} ignoreFiles = ['\.foo$', '\.boo$'] {{< /code-toggle >}} To ignore a file using the absolute file path: -{{< code-toggle copy=false >}} +{{< code-toggle copy=false file="hugo" >}} ignoreFiles = ['^/home/user/project/content/test\.md$'] {{< /code-toggle >}} @@ -664,11 +664,11 @@ ignoreFiles = ['^/home/user/project/content/test\.md$'] ### Configure Dates -Dates are important in Hugo, and you can configure how Hugo assigns dates to your content pages. You do this by adding a `frontmatter` section to your `config.toml`. +Dates are important in Hugo, and you can configure how Hugo assigns dates to your content pages. You do this by adding a `frontmatter` section to your `hugo.toml`. The default configuration is: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [frontmatter] date = ["date", "publishDate", "lastmod"] lastmod = [":git", "lastmod", "date", "publishDate"] @@ -678,7 +678,7 @@ expiryDate = ["expiryDate"] If you, as an example, have a non-standard date parameter in some of your content, you can override the setting for `date`: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [frontmatter] date = ["myDate", ":default"] {{< /code-toggle >}} @@ -695,7 +695,7 @@ The special date handlers are: An example: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [frontmatter] lastmod = ["lastmod", ":fileModTime", ":default"] {{< /code-toggle >}} @@ -709,7 +709,7 @@ The above will try first to extract the value for `.Lastmod` starting with the ` An example: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [frontmatter] date = [":filename", ":default"] {{< /code-toggle >}} @@ -734,7 +734,7 @@ Default configuration: Since Hugo 0.52 you can configure more than just the `cacheDir`. This is the default configuration: -{{< code-toggle >}} +{{< code-toggle file="hugo" >}} [caches] [caches.getjson] dir = ":cacheDir/:project" @@ -756,7 +756,7 @@ dir = ":cacheDir/modules" maxAge = -1 {{< /code-toggle >}} -You can override any of these cache settings in your own `config.toml`. +You can override any of these cache settings in your own `hugo.toml`. ### The keywords explained diff --git a/content/en/getting-started/directory-structure.md b/content/en/getting-started/directory-structure.md index da0f9c761..7618570b0 100644 --- a/content/en/getting-started/directory-structure.md +++ b/content/en/getting-started/directory-structure.md @@ -29,7 +29,7 @@ example/ ├── public/ ├── static/ ├── themes/ -└── config.toml +└── hugo.toml ``` ## Directory Structure Explained @@ -46,7 +46,7 @@ By default, Hugo will create new content files with at least `date`, `title` (in [`config`](/getting-started/configuration/) : Hugo ships with a large number of [configuration directives]. The [config directory](/getting-started/configuration/#configuration-directory) is where those directives are stored as JSON, YAML, or TOML files. Every root setting object can stand as its own file and structured by environments. -Projects with minimal settings and no need for environment awareness can use a single `config.toml` file at its root. +Projects with minimal settings and no need for environment awareness can use a single `hugo.toml` file at its root. Many sites may need little to no configuration, but Hugo ships with a large number of [configuration directives] for more granular directions on how you want Hugo to build your website. Note: config directory is not created by default. diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index da35c314c..167dfc0e1 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -23,7 +23,7 @@ In this tutorial you will: Before you begin this tutorial you must: -1. [Install Hugo] (the extended edition) +1. [Install Hugo] (extended edition, v0.112.0 or later) 1. [Install Git] You must also be comfortable working from the command line. @@ -51,7 +51,7 @@ hugo new site quickstart cd quickstart git init git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/ananke -echo "theme = 'ananke'" >> config.toml +echo "theme = 'ananke'" >> hugo.toml hugo server ``` @@ -86,7 +86,7 @@ git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke themes/an Append a line to the site configuration file, indicating the current theme. ```text -echo "theme = 'ananke'" >> config.toml +echo "theme = 'ananke'" >> hugo.toml ``` Start Hugo's development server to view the site. @@ -152,7 +152,7 @@ Hugo's rendering engine conforms to the CommonMark [specification] for markdown. ## Configure the site -With your editor, open the [site configuration] file (`config.toml`) in the root of your project. +With your editor, open the [site configuration] file (`hugo.toml`) in the root of your project. ```text baseURL = 'http://example.org/' diff --git a/content/en/hugo-modules/configuration.md b/content/en/hugo-modules/configuration.md index 8620314d0..828e7fcc8 100644 --- a/content/en/hugo-modules/configuration.md +++ b/content/en/hugo-modules/configuration.md @@ -13,7 +13,7 @@ toc: true ## Module Config: Top level -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [module] noVendor = "" proxy = "direct" @@ -56,7 +56,7 @@ env HUGO_MODULE_PROXY=https://proxy.example.org hugo If your module requires a particular version of Hugo to work, you can indicate that in the `module` section and the user will be warned if using a too old/new version. -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [module] [module.hugoVersion] min = "" @@ -78,7 +78,7 @@ extended ## Module Config: imports -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [module] [[module.imports]] path = "github.com/gohugoio/hugoTestModules1_linux/modh1_2_1v" @@ -93,7 +93,7 @@ path : Can be either a valid Go Module module path, e.g. `github.com/gohugoio/myShortcodes`, or the directory name for the module as stored in your themes folder. ignoreConfig -: If enabled, any module configuration file, e.g. `config.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies. +: If enabled, any module configuration file, e.g. `hugo.toml`, will not be loaded. Note that this will also stop the loading of any transitive module dependencies. ignoreImports : If enabled, module imports will not be followed. @@ -120,7 +120,7 @@ When you add a mount, the default mount for the concerned target root is ignored {{% /note %}} **Default mounts** -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [module] [[module.mounts]] source="content" @@ -165,7 +165,7 @@ excludeFiles (string or slice) : One or more glob patterns matching files to exclude. **Example** -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} [module] [[module.mounts]] source="content" diff --git a/content/en/hugo-modules/theme-components.md b/content/en/hugo-modules/theme-components.md index 10aa1277f..d0005c8e8 100644 --- a/content/en/hugo-modules/theme-components.md +++ b/content/en/hugo-modules/theme-components.md @@ -17,13 +17,13 @@ This section contain information that may be outdated and is in the process of b {{% /note %}} Since Hugo `0.42` a project can configure a theme as a composite of as many theme components you need: -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} theme = ["my-shortcodes", "base-theme", "hyde"] {{< /code-toggle >}} -You can even nest this, and have the theme component itself include theme components in its own `config.toml` (theme inheritance).[^1] +You can even nest this, and have the theme component itself include theme components in its own `hugo.toml` (theme inheritance).[^1] -The theme definition example above in `config.toml` creates a theme with 3 theme components with precedence from left to right. +The theme definition example above in `hugo.toml` creates a theme with 3 theme components with precedence from left to right. For any given file, data entry, etc., Hugo will look first in the project and then in `my-shortcodes`, `base-theme`, and lastly `hyde`. @@ -34,7 +34,7 @@ Hugo uses two different algorithms to merge the filesystems, depending on the fi The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically. -Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure: +Also note that a component that is part of a theme can have its own configuration file, e.g. `hugo.toml`. There are currently some restrictions to what a theme component can configure: * `params` (global and per language) * `menu` (global and per language) diff --git a/content/en/hugo-modules/use-modules.md b/content/en/hugo-modules/use-modules.md index 99c1229b5..a33bf844e 100644 --- a/content/en/hugo-modules/use-modules.md +++ b/content/en/hugo-modules/use-modules.md @@ -33,7 +33,7 @@ The easiest way to use a Module for a theme is to import it in the config. 1. Initialize the hugo module system: `hugo mod init github.com//` 2. Import the theme: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [module] [[module.imports]] path = "github.com/spf13/hyde" diff --git a/content/en/hugo-pipes/introduction.md b/content/en/hugo-pipes/introduction.md index c551dad61..6e4cd76fb 100755 --- a/content/en/hugo-pipes/introduction.md +++ b/content/en/hugo-pipes/introduction.md @@ -124,10 +124,19 @@ Remote resources fetched with `resources.GetRemote` will be cached on disk. See `resources.Copy` allows you to copy almost any Hugo `Resource` (the one exception is the `Page`), possibly most useful for renaming things: ```go-html-template -{{ $resized := $image.Resize "400x400" | resources.Copy "images/mynewname.jpg" }} - +{{ with resources.Get "img/a.jpg" }} + {{ with .Resize "300x" }} + {{ with resources.Copy "img/a-new.jpg" . }} + + {{ 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. diff --git a/content/en/hugo-pipes/postprocess.md b/content/en/hugo-pipes/postprocess.md index b9e5c62c6..f90b9854b 100755 --- a/content/en/hugo-pipes/postprocess.md +++ b/content/en/hugo-pipes/postprocess.md @@ -36,7 +36,7 @@ There are several ways to set up CSS purging with PostCSS in Hugo. If you have a The below configuration will write a `hugo_stats.json` file to the project root as part of the build. If you're only using this for the production build, you should consider placing it below [config/production](/getting-started/configuration/#configuration-directory). -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [build] writeStats = true {{< /code-toggle >}} diff --git a/content/en/templates/internal.md b/content/en/templates/internal.md index 52e40b5a1..9ec79a16c 100644 --- a/content/en/templates/internal.md +++ b/content/en/templates/internal.md @@ -31,12 +31,12 @@ Hugo ships with internal templates supporting Google Analytics, both [Google Ana Provide your tracking ID in your configuration file: **Google Analytics 4 (gtag.js)** -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} googleAnalytics = "G-MEASUREMENT_ID" {{}} **Google Universal Analytics (analytics.js)** -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} googleAnalytics = "UA-PROPERTY_ID" {{}} @@ -64,7 +64,7 @@ Hugo also ships with an internal template for [Disqus comments][disqus], a popul To use Hugo's Disqus template, you first need to set a single configuration value: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} disqusShortname = "your-disqus-shortname" {{}} @@ -127,7 +127,7 @@ This format is used for Facebook and some other sites. Hugo's Open Graph template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [params] title = "My cool site" images = ["site-feature-image.jpg"] @@ -177,7 +177,7 @@ metadata used to attach rich media to Tweets linking to your site. Hugo's Twitter Card template is configured using a mix of configuration variables and [front-matter](/content-management/front-matter/) on individual pages. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [params] images = ["site-feature-image.jpg"] description = "Text about my cool site" @@ -197,7 +197,7 @@ Hugo uses the page title and description for the card's title and description fi The `.Site.Social.twitter` variable is exposed from the config as the value for `twitter:site`. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [social] twitter = "GoHugoIO" {{}} diff --git a/content/en/templates/introduction.md b/content/en/templates/introduction.md index f02f1dfce..2fb7f094f 100644 --- a/content/en/templates/introduction.md +++ b/content/en/templates/introduction.md @@ -562,7 +562,7 @@ You can arbitrarily define as many site-level parameters as you want in your [si For instance, you might declare the following: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} params: copyrighthtml: "Copyright © 2017 John Doe. All Rights Reserved." twitteruser: "spf13" diff --git a/content/en/templates/output-formats.md b/content/en/templates/output-formats.md index f8448b097..d454ecc0d 100644 --- a/content/en/templates/output-formats.md +++ b/content/en/templates/output-formats.md @@ -31,7 +31,7 @@ This is the full set of built-in media types in Hugo: To add or modify a media type, define it in a `mediaTypes` section in your [site configuration][config], either for all sites or for a given language. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [mediaTypes] [mediaTypes."text/enriched"] suffixes = ["enr"] @@ -43,7 +43,7 @@ The above example adds one new media type, `text/enriched`, and changes the suff **Note:** these media types are configured for **your output formats**. If you want to redefine one of Hugo's default output formats (e.g. `HTML`), you also need to redefine the media type. So, if you want to change the suffix of the `HTML` output format from `html` (default) to `htm`: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [mediaTypes] [mediaTypes."text/html"] suffixes = ["htm"] @@ -70,7 +70,7 @@ This is the full set of Hugo's built-in output formats: To add or modify an output format, define it in an `outputFormats` section in your site's [configuration file](/getting-started/configuration/), either for all sites or for a given language. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [outputFormats.MyEnrichedFormat] mediaType = "text/enriched" baseName = "myindex" @@ -146,7 +146,7 @@ per language). Example from site config file: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [outputs] home = ["HTML", "AMP", "RSS"] page = ["HTML"] diff --git a/content/en/templates/robots.md b/content/en/templates/robots.md index 6554d4047..a658ded24 100644 --- a/content/en/templates/robots.md +++ b/content/en/templates/robots.md @@ -14,7 +14,7 @@ aliases: [/extras/robots-txt/] To generate a robots.txt file from a template, change the [site configuration][config]: -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} enableRobotsTXT = true {{< /code-toggle >}} diff --git a/content/en/templates/rss.md b/content/en/templates/rss.md index af2ee2c12..c378a65f5 100644 --- a/content/en/templates/rss.md +++ b/content/en/templates/rss.md @@ -35,11 +35,11 @@ The table below shows the RSS template lookup order for the different page kinds ## Configure RSS -By default, Hugo will create an unlimited number of RSS entries. You can limit the number of articles included in the built-in RSS templates by assigning a numeric value to `rssLimit:` field in your project's [`config` file][config]. +By default, Hugo will create an unlimited number of RSS entries. You can limit the number of articles included in the built-in RSS templates by assigning a numeric value to `rssLimit:` field in your project's configuration file. The following values will also be included in the RSS output if specified: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} languageCode = "en-us" copyright = "This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License." diff --git a/content/en/templates/shortcode-templates.md b/content/en/templates/shortcode-templates.md index 80ef9f365..21078a634 100644 --- a/content/en/templates/shortcode-templates.md +++ b/content/en/templates/shortcode-templates.md @@ -368,7 +368,7 @@ You can also implement your shortcodes inline -- e.g. where you use them in the This feature is disabled by default, but can be enabled in your site config: -{{< code-toggle file="config">}} +{{< code-toggle file="hugo" >}} enableInlineShortcodes = true {{< /code-toggle >}} diff --git a/content/en/templates/sitemap-template.md b/content/en/templates/sitemap-template.md index d0738a362..37462a086 100644 --- a/content/en/templates/sitemap-template.md +++ b/content/en/templates/sitemap-template.md @@ -27,7 +27,7 @@ With a multilingual project, Hugo generates: Set the default values for [change frequency] and [priority], and the name of the generated file, in your site configuration. -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} [sitemap] changefreq = 'monthly' filename = 'sitemap.xml' @@ -72,7 +72,7 @@ To override the built-in sitemapindex.xml template, create a new file in either You may disable sitemap generation in your site configuration: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} disableKinds = ['sitemap'] {{}} diff --git a/content/en/variables/page.md b/content/en/variables/page.md index f8266965e..edad543ad 100644 --- a/content/en/variables/page.md +++ b/content/en/variables/page.md @@ -76,7 +76,7 @@ The following is a list of page-level variables. Many of these will be defined i : the page's *kind*. Possible return values are `page`, `home`, `section`, `taxonomy`, or `term`. Note that there are also `RSS`, `sitemap`, `robotsTXT`, and `404` kinds, but these are only available during the rendering of each of these respective page's kind and therefore *not* available in any of the `Pages` collections. .Language -: a language object that points to the language's definition in the site `config`. `.Language.Lang` gives you the language code. +: a language object that points to the language's definition in the site configuration. `.Language.Lang` gives you the language code. .Lastmod : the date the content was last modified. `.Lastmod` pulls from the `lastmod` field in a content's front matter. @@ -298,7 +298,7 @@ In Hugo, you can declare params in individual pages and globally for your entire {{ $.Param "header_image" }} ``` -The `.Param` method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your `config`). +The `.Param` method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your site configuration). ### Access Nested Fields in Front Matter diff --git a/content/en/variables/site.md b/content/en/variables/site.md index 71111eb83..7e587cc79 100644 --- a/content/en/variables/site.md +++ b/content/en/variables/site.md @@ -100,7 +100,7 @@ All the methods below, e.g. `.Site.RegularPages` can also be reached via the glo The following `config.[yaml|toml|json]` defines a site-wide param for `description`: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} baseURL = "https://yoursite.example.com/" [params] diff --git a/data/docs.json b/data/docs.json index 6efb03f8f..d75c35730 100644 --- a/data/docs.json +++ b/data/docs.json @@ -614,6 +614,12 @@ "hlsl" ] }, + { + "Name": "HolyC", + "Aliases": [ + "holyc" + ] + }, { "Name": "HTML", "Aliases": [ @@ -837,6 +843,12 @@ "nasm" ] }, + { + "Name": "Natural", + "Aliases": [ + "natural" + ] + }, { "Name": "Newspeak", "Aliases": [ @@ -1523,6 +1535,12 @@ "yang" ] }, + { + "Name": "Z80 Assembly", + "Aliases": [ + "z80" + ] + }, { "Name": "Zed", "Aliases": [ @@ -1576,7 +1594,19 @@ "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, @@ -1693,7 +1723,8 @@ "js": { "precision": 0, "keepVarNames": false, - "noNullishOperator": false + "noNullishOperator": false, + "version": 0 }, "json": { "precision": 0, @@ -1728,6 +1759,7 @@ ] }, "http": { + "mediaTypes": null, "methods": [ "(?i)GET|POST" ], @@ -1743,10 +1775,6 @@ "mainType": "application", "subType": "json", "delimiter": ".", - "firstSuffix": { - "suffix": "json", - "fullSuffix": ".json" - }, "type": "application/json", "string": "application/json", "suffixes": [ @@ -1757,10 +1785,6 @@ "mainType": "application", "subType": "manifest", "delimiter": ".", - "firstSuffix": { - "suffix": "webmanifest", - "fullSuffix": ".webmanifest" - }, "type": "application/manifest+json", "string": "application/manifest+json", "suffixes": [ @@ -1771,10 +1795,6 @@ "mainType": "application", "subType": "octet-stream", "delimiter": ".", - "firstSuffix": { - "suffix": "", - "fullSuffix": "" - }, "type": "application/octet-stream", "string": "application/octet-stream", "suffixes": [ @@ -1785,10 +1805,6 @@ "mainType": "application", "subType": "pdf", "delimiter": ".", - "firstSuffix": { - "suffix": "pdf", - "fullSuffix": ".pdf" - }, "type": "application/pdf", "string": "application/pdf", "suffixes": [ @@ -1799,10 +1815,6 @@ "mainType": "application", "subType": "rss", "delimiter": ".", - "firstSuffix": { - "suffix": "xml", - "fullSuffix": ".xml" - }, "type": "application/rss+xml", "string": "application/rss+xml", "suffixes": [ @@ -1814,24 +1826,26 @@ "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": [ @@ -1842,10 +1856,6 @@ "mainType": "application", "subType": "yaml", "delimiter": ".", - "firstSuffix": { - "suffix": "yaml", - "fullSuffix": ".yaml" - }, "type": "application/yaml", "string": "application/yaml", "suffixes": [ @@ -1857,10 +1867,6 @@ "mainType": "font", "subType": "otf", "delimiter": ".", - "firstSuffix": { - "suffix": "otf", - "fullSuffix": ".otf" - }, "type": "font/otf", "string": "font/otf", "suffixes": [ @@ -1871,10 +1877,6 @@ "mainType": "font", "subType": "ttf", "delimiter": ".", - "firstSuffix": { - "suffix": "ttf", - "fullSuffix": ".ttf" - }, "type": "font/ttf", "string": "font/ttf", "suffixes": [ @@ -1885,10 +1887,6 @@ "mainType": "image", "subType": "bmp", "delimiter": ".", - "firstSuffix": { - "suffix": "bmp", - "fullSuffix": ".bmp" - }, "type": "image/bmp", "string": "image/bmp", "suffixes": [ @@ -1899,10 +1897,6 @@ "mainType": "image", "subType": "gif", "delimiter": ".", - "firstSuffix": { - "suffix": "gif", - "fullSuffix": ".gif" - }, "type": "image/gif", "string": "image/gif", "suffixes": [ @@ -1913,10 +1907,6 @@ "mainType": "image", "subType": "jpeg", "delimiter": ".", - "firstSuffix": { - "suffix": "jpg", - "fullSuffix": ".jpg" - }, "type": "image/jpeg", "string": "image/jpeg", "suffixes": [ @@ -1931,10 +1921,6 @@ "mainType": "image", "subType": "png", "delimiter": ".", - "firstSuffix": { - "suffix": "png", - "fullSuffix": ".png" - }, "type": "image/png", "string": "image/png", "suffixes": [ @@ -1945,24 +1931,27 @@ "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": [ @@ -1973,10 +1962,6 @@ "mainType": "text", "subType": "calendar", "delimiter": ".", - "firstSuffix": { - "suffix": "ics", - "fullSuffix": ".ics" - }, "type": "text/calendar", "string": "text/calendar", "suffixes": [ @@ -1987,10 +1972,6 @@ "mainType": "text", "subType": "css", "delimiter": ".", - "firstSuffix": { - "suffix": "css", - "fullSuffix": ".css" - }, "type": "text/css", "string": "text/css", "suffixes": [ @@ -2001,10 +1982,6 @@ "mainType": "text", "subType": "csv", "delimiter": ".", - "firstSuffix": { - "suffix": "csv", - "fullSuffix": ".csv" - }, "type": "text/csv", "string": "text/csv", "suffixes": [ @@ -2015,10 +1992,6 @@ "mainType": "text", "subType": "html", "delimiter": ".", - "firstSuffix": { - "suffix": "html", - "fullSuffix": ".html" - }, "type": "text/html", "string": "text/html", "suffixes": [ @@ -2029,10 +2002,6 @@ "mainType": "text", "subType": "javascript", "delimiter": ".", - "firstSuffix": { - "suffix": "js", - "fullSuffix": ".js" - }, "type": "text/javascript", "string": "text/javascript", "suffixes": [ @@ -2045,10 +2014,6 @@ "mainType": "text", "subType": "jsx", "delimiter": ".", - "firstSuffix": { - "suffix": "jsx", - "fullSuffix": ".jsx" - }, "type": "text/jsx", "string": "text/jsx", "suffixes": [ @@ -2059,10 +2024,6 @@ "mainType": "text", "subType": "markdown", "delimiter": ".", - "firstSuffix": { - "suffix": "md", - "fullSuffix": ".md" - }, "type": "text/markdown", "string": "text/markdown", "suffixes": [ @@ -2074,10 +2035,6 @@ "mainType": "text", "subType": "plain", "delimiter": ".", - "firstSuffix": { - "suffix": "txt", - "fullSuffix": ".txt" - }, "type": "text/plain", "string": "text/plain", "suffixes": [ @@ -2088,10 +2045,6 @@ "mainType": "text", "subType": "tsx", "delimiter": ".", - "firstSuffix": { - "suffix": "tsx", - "fullSuffix": ".tsx" - }, "type": "text/tsx", "string": "text/tsx", "suffixes": [ @@ -2102,10 +2055,6 @@ "mainType": "text", "subType": "typescript", "delimiter": ".", - "firstSuffix": { - "suffix": "ts", - "fullSuffix": ".ts" - }, "type": "text/typescript", "string": "text/typescript", "suffixes": [ @@ -2116,10 +2065,6 @@ "mainType": "text", "subType": "x-sass", "delimiter": ".", - "firstSuffix": { - "suffix": "sass", - "fullSuffix": ".sass" - }, "type": "text/x-sass", "string": "text/x-sass", "suffixes": [ @@ -2130,10 +2075,6 @@ "mainType": "text", "subType": "x-scss", "delimiter": ".", - "firstSuffix": { - "suffix": "scss", - "fullSuffix": ".scss" - }, "type": "text/x-scss", "string": "text/x-scss", "suffixes": [ @@ -2144,10 +2085,6 @@ "mainType": "video", "subType": "3gpp", "delimiter": ".", - "firstSuffix": { - "suffix": "3gpp", - "fullSuffix": ".3gpp" - }, "type": "video/3gpp", "string": "video/3gpp", "suffixes": [ @@ -2159,10 +2096,6 @@ "mainType": "video", "subType": "mp4", "delimiter": ".", - "firstSuffix": { - "suffix": "mp4", - "fullSuffix": ".mp4" - }, "type": "video/mp4", "string": "video/mp4", "suffixes": [ @@ -2173,10 +2106,6 @@ "mainType": "video", "subType": "mpeg", "delimiter": ".", - "firstSuffix": { - "suffix": "mpg", - "fullSuffix": ".mpg" - }, "type": "video/mpeg", "string": "video/mpeg", "suffixes": [ @@ -2188,10 +2117,6 @@ "mainType": "video", "subType": "ogg", "delimiter": ".", - "firstSuffix": { - "suffix": "ogv", - "fullSuffix": ".ogv" - }, "type": "video/ogg", "string": "video/ogg", "suffixes": [ @@ -2202,10 +2127,6 @@ "mainType": "video", "subType": "webm", "delimiter": ".", - "firstSuffix": { - "suffix": "webm", - "fullSuffix": ".webm" - }, "type": "video/webm", "string": "video/webm", "suffixes": [ @@ -2216,10 +2137,6 @@ "mainType": "video", "subType": "x-msvideo", "delimiter": ".", - "firstSuffix": { - "suffix": "avi", - "fullSuffix": ".avi" - }, "type": "video/x-msvideo", "string": "video/x-msvideo", "suffixes": [ @@ -2232,7 +2149,7 @@ "formats": [ { "mediaType": "text/html", - "name": "HTML", + "name": "html", "path": "", "baseName": "index", "rel": "canonical", @@ -2246,7 +2163,7 @@ }, { "mediaType": "text/html", - "name": "AMP", + "name": "amp", "path": "amp", "baseName": "index", "rel": "amphtml", @@ -2258,9 +2175,23 @@ "permalinkable": true, "weight": 0 }, + { + "mediaType": "text/calendar", + "name": "calendar", + "path": "", + "baseName": "index", + "rel": "alternate", + "protocol": "webcal://", + "isPlainText": true, + "isHTML": false, + "noUgly": false, + "notAlternative": false, + "permalinkable": false, + "weight": 0 + }, { "mediaType": "text/css", - "name": "CSS", + "name": "css", "path": "", "baseName": "styles", "rel": "stylesheet", @@ -2274,7 +2205,7 @@ }, { "mediaType": "text/csv", - "name": "CSV", + "name": "csv", "path": "", "baseName": "index", "rel": "alternate", @@ -2286,23 +2217,9 @@ "permalinkable": false, "weight": 0 }, - { - "mediaType": "text/calendar", - "name": "Calendar", - "path": "", - "baseName": "index", - "rel": "alternate", - "protocol": "webcal://", - "isPlainText": true, - "isHTML": false, - "noUgly": false, - "notAlternative": false, - "permalinkable": false, - "weight": 0 - }, { "mediaType": "application/json", - "name": "JSON", + "name": "json", "path": "", "baseName": "index", "rel": "alternate", @@ -2316,7 +2233,7 @@ }, { "mediaType": "text/markdown", - "name": "MARKDOWN", + "name": "markdown", "path": "", "baseName": "index", "rel": "alternate", @@ -2330,7 +2247,7 @@ }, { "mediaType": "text/plain", - "name": "ROBOTS", + "name": "robots", "path": "", "baseName": "robots", "rel": "alternate", @@ -2344,7 +2261,7 @@ }, { "mediaType": "application/rss+xml", - "name": "RSS", + "name": "rss", "path": "", "baseName": "index", "rel": "alternate", @@ -2358,7 +2275,7 @@ }, { "mediaType": "application/xml", - "name": "Sitemap", + "name": "sitemap", "path": "", "baseName": "sitemap", "rel": "sitemap", @@ -2372,7 +2289,7 @@ }, { "mediaType": "application/manifest+json", - "name": "WebAppManifest", + "name": "webappmanifest", "path": "", "baseName": "manifest", "rel": "manifest", @@ -2389,7 +2306,7 @@ { "Example": "Single page in \"posts\" section", "Kind": "page", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/single.html.html", @@ -2401,7 +2318,7 @@ { "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", @@ -2417,7 +2334,7 @@ { "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", @@ -2433,7 +2350,7 @@ { "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", @@ -2453,7 +2370,7 @@ { "Example": "AMP single page", "Kind": "page", - "OutputFormat": "AMP", + "OutputFormat": "amp", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/single.amp.html", @@ -2465,15 +2382,15 @@ { "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" ] @@ -2481,7 +2398,7 @@ { "Example": "Home page", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/index.html.html", @@ -2501,7 +2418,7 @@ { "Example": "Base template for home page", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/index-baseof.html.html", @@ -2525,7 +2442,7 @@ { "Example": "Home page with type set", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/demotype/index.html.html", @@ -2551,7 +2468,7 @@ { "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", @@ -2583,7 +2500,7 @@ { "Example": "Home page with layout set", "Kind": "home", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/demolayout.html.html", @@ -2607,7 +2524,7 @@ { "Example": "AMP home, French language", "Kind": "home", - "OutputFormat": "AMP", + "OutputFormat": "amp", "Suffix": "html", "Template Lookup Order": [ "layouts/index.fr.amp.html", @@ -2639,7 +2556,7 @@ { "Example": "JSON home", "Kind": "home", - "OutputFormat": "JSON", + "OutputFormat": "json", "Suffix": "json", "Template Lookup Order": [ "layouts/index.json.json", @@ -2659,7 +2576,7 @@ { "Example": "RSS home", "Kind": "home", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/index.rss.xml", @@ -2682,7 +2599,7 @@ { "Example": "RSS section posts", "Kind": "section", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/posts/section.rss.xml", @@ -2706,7 +2623,7 @@ { "Example": "Taxonomy in categories", "Kind": "taxonomy", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/categories/category.terms.rss.xml", @@ -2751,7 +2668,7 @@ { "Example": "Term in categories", "Kind": "term", - "OutputFormat": "RSS", + "OutputFormat": "rss", "Suffix": "xml", "Template Lookup Order": [ "layouts/categories/term.rss.xml", @@ -2805,7 +2722,7 @@ { "Example": "Section list for \"posts\" section", "Kind": "section", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/posts/posts.html.html", @@ -2831,7 +2748,7 @@ { "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", @@ -2863,7 +2780,7 @@ { "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", @@ -2895,7 +2812,7 @@ { "Example": "Taxonomy list in categories", "Kind": "taxonomy", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/categories/category.terms.html.html", @@ -2935,7 +2852,7 @@ { "Example": "Taxonomy term in categories", "Kind": "term", - "OutputFormat": "HTML", + "OutputFormat": "html", "Suffix": "html", "Template Lookup Order": [ "layouts/categories/term.html.html", @@ -3522,7 +3439,7 @@ }, "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" ], @@ -3652,6 +3569,12 @@ "map[string]interface {}{\n \"Hugo\": \"Rocks!\",\n}" ] ] + }, + "VisualizeSpaces": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null } }, "diagrams": { @@ -3844,6 +3767,12 @@ "Args": null, "Aliases": null, "Examples": null + }, + "WorkingDir": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null } }, "images": { @@ -4073,7 +4002,7 @@ ] }, "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", @@ -4097,6 +4026,10 @@ "{{ lang.FormatNumberCustom 0 -12345.6789 \"- . ,\" }}", "-12,346" ], + [ + "{{ lang.FormatNumberCustom 0 -12345.6789 \"-|.| \" \"|\" }}", + "-12 346" + ], [ "{{ -98765.4321 | lang.FormatNumberCustom 2 }}", "-98,765.43" @@ -4132,6 +4065,7 @@ "Translate": { "Description": "Translate returns a translated string for id.", "Args": [ + "ctx", "id", "args" ], @@ -4143,11 +4077,23 @@ } }, "math": { - "Add": { - "Description": "Add adds the two addends n1 and n2.", + "Abs": { + "Description": "Abs returns the absolute value of n.", "Args": [ - "n1", - "n2" + "n" + ], + "Aliases": null, + "Examples": [ + [ + "{{ math.Abs -2.1 }}", + "2.1" + ] + ] + }, + "Add": { + "Description": "Add adds the multivalued addends n1 and n2 or more values.", + "Args": [ + "inputs" ], "Aliases": [ "add" @@ -4181,8 +4127,7 @@ "Div": { "Description": "Div divides n1 by n2.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": [ "div" @@ -4221,10 +4166,9 @@ ] }, "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": [ @@ -4235,10 +4179,9 @@ ] }, "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": [ @@ -4281,10 +4224,9 @@ ] }, "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" @@ -4339,10 +4281,9 @@ ] }, "Sub": { - "Description": "Sub subtracts n2 from n1.", + "Description": "Sub subtracts multivalued.", "Args": [ - "n1", - "n2" + "inputs" ], "Aliases": [ "sub" @@ -4630,7 +4571,7 @@ "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" ], @@ -4670,7 +4611,7 @@ "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" ], @@ -4778,12 +4719,48 @@ } }, "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, @@ -4796,12 +4773,36 @@ "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, @@ -4814,6 +4815,12 @@ "Aliases": null, "Examples": null }, + "IsMultiLingual": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "IsServer": { "Description": "", "Args": null, @@ -4826,12 +4833,36 @@ "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, @@ -4844,6 +4875,12 @@ "Aliases": null, "Examples": null }, + "Param": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Params": { "Description": "", "Args": null, @@ -4856,6 +4893,12 @@ "Aliases": null, "Examples": null }, + "Sections": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "ServerPort": { "Description": "", "Args": null, @@ -4868,6 +4911,12 @@ "Aliases": null, "Examples": null }, + "Social": { + "Description": "", + "Args": null, + "Aliases": null, + "Examples": null + }, "Taxonomies": { "Description": "", "Args": null, @@ -4991,7 +5040,7 @@ ] }, "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", @@ -5041,10 +5090,24 @@ ] }, "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.", @@ -5592,6 +5655,23 @@ ] ] }, + "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, diff --git a/go.mod b/go.mod index 07badfeaf..3c5460fd5 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,4 @@ module github.com/gohugoio/hugoDocs go 1.16 -require github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11 // indirect +require github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a // indirect diff --git a/go.sum b/go.sum index 6783cb92e..9db956ea8 100644 --- a/go.sum +++ b/go.sum @@ -63,3 +63,5 @@ github.com/gohugoio/gohugoioTheme v0.0.0-20230330081257-7a8c9614432c h1:TyHgmowf github.com/gohugoio/gohugoioTheme v0.0.0-20230330081257-7a8c9614432c/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11 h1:mDcricMewd66x8QjKqNun7Div7iYVLtl8s1dVs9VnB8= github.com/gohugoio/gohugoioTheme v0.0.0-20230418063032-99f9185b8e11/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= +github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a h1:ruyA3QZ4Ym0fBLhTW2eoUSvHUaj2xWqaPHIbaI+tbZo= +github.com/gohugoio/gohugoioTheme v0.0.0-20230527124826-78bc315d7b8a/go.mod h1:GOYeAPQJ/ok8z7oz1cjfcSlsFpXrmx6VkzQ5RpnyhZM= diff --git a/layouts/shortcodes/code-toggle.html b/layouts/shortcodes/code-toggle.html index b4cfaaa20..3b151669f 100644 --- a/layouts/shortcodes/code-toggle.html +++ b/layouts/shortcodes/code-toggle.html @@ -44,7 +44,7 @@ Renders syntax-highlighted configuration data in JSON, TOML, and YAML formats. {{- /* Render. */}} {{- $code := "" }} {{- with $config }} - {{- $file = $file | default "config" }} + {{- $file = $file | default "hugo" }} {{- $sections := (split . ".") }} {{- $configSection := index $.Site.Data.docs.config $sections }} {{- $code = dict $sections $configSection }} diff --git a/layouts/shortcodes/new-in.html b/layouts/shortcodes/new-in.html index e81fda3c5..71d1abfdf 100644 --- a/layouts/shortcodes/new-in.html +++ b/layouts/shortcodes/new-in.html @@ -1,8 +1,13 @@ {{ $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" }} - diff --git a/netlify.toml b/netlify.toml index a07e29a94..c3c26e87f 100644 --- a/netlify.toml +++ b/netlify.toml @@ -3,7 +3,7 @@ publish = "public" command = "hugo --gc --minify" [context.production.environment] -HUGO_VERSION = "0.111.3" +HUGO_VERSION = "0.112.3" HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" @@ -11,20 +11,20 @@ HUGO_ENABLEGITINFO = "true" command = "hugo --gc --minify --enableGitInfo" [context.split1.environment] -HUGO_VERSION = "0.111.3" +HUGO_VERSION = "0.112.3" HUGO_ENV = "production" [context.deploy-preview] command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL" [context.deploy-preview.environment] -HUGO_VERSION = "0.111.3" +HUGO_VERSION = "0.112.3" [context.branch-deploy] command = "hugo --gc --minify -b $DEPLOY_PRIME_URL" [context.branch-deploy.environment] -HUGO_VERSION = "0.111.3" +HUGO_VERSION = "0.112.3" [context.next.environment] HUGO_ENABLEGITINFO = "true"