diff --git a/docs/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers b/docs/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers index fedd73525..1216e42d4 100644 --- a/docs/_vendor/github.com/gohugoio/gohugoioTheme/layouts/index.headers +++ b/docs/_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/docs/_vendor/modules.txt b/docs/_vendor/modules.txt index 5c4b53271..1c7cac307 100644 --- a/docs/_vendor/modules.txt +++ b/docs/_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/docs/content/en/about/hugo-and-gdpr.md b/docs/content/en/about/hugo-and-gdpr.md index 3e0a160c7..b028c4543 100644 --- a/docs/content/en/about/hugo-and-gdpr.md +++ b/docs/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/docs/content/en/commands/hugo.md b/docs/content/en/commands/hugo.md index 73d443169..8dbdd6231 100644 --- a/docs/content/en/commands/hugo.md +++ b/docs/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 diff --git a/docs/content/en/commands/hugo_completion.md b/docs/content/en/commands/hugo_completion.md index d7cc64cc2..7ab87f800 100644 --- a/docs/content/en/commands/hugo_completion.md +++ b/docs/content/en/commands/hugo_completion.md @@ -28,6 +28,7 @@ See each sub-command's help for details on how to use the generated script. --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/docs/content/en/commands/hugo_completion_bash.md b/docs/content/en/commands/hugo_completion_bash.md index eb6fdd8d4..a4d4d6f11 100644 --- a/docs/content/en/commands/hugo_completion_bash.md +++ b/docs/content/en/commands/hugo_completion_bash.md @@ -51,6 +51,7 @@ hugo completion bash --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/docs/content/en/commands/hugo_completion_fish.md b/docs/content/en/commands/hugo_completion_fish.md index f81acb8af..6fe2d7f16 100644 --- a/docs/content/en/commands/hugo_completion_fish.md +++ b/docs/content/en/commands/hugo_completion_fish.md @@ -42,6 +42,7 @@ hugo completion fish [flags] --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/docs/content/en/commands/hugo_completion_powershell.md b/docs/content/en/commands/hugo_completion_powershell.md index 5f900ec59..614023dbb 100644 --- a/docs/content/en/commands/hugo_completion_powershell.md +++ b/docs/content/en/commands/hugo_completion_powershell.md @@ -39,6 +39,7 @@ hugo completion powershell [flags] --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/docs/content/en/commands/hugo_completion_zsh.md b/docs/content/en/commands/hugo_completion_zsh.md index fbe5c6ad4..7e17bc96d 100644 --- a/docs/content/en/commands/hugo_completion_zsh.md +++ b/docs/content/en/commands/hugo_completion_zsh.md @@ -53,6 +53,7 @@ hugo completion zsh [flags] --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/docs/content/en/commands/hugo_config_mounts.md b/docs/content/en/commands/hugo_config_mounts.md index 9ec0a5e7f..1019f5102 100644 --- a/docs/content/en/commands/hugo_config_mounts.md +++ b/docs/content/en/commands/hugo_config_mounts.md @@ -26,6 +26,7 @@ hugo config mounts [flags] [args] --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/docs/content/en/commands/hugo_convert_toJSON.md b/docs/content/en/commands/hugo_convert_toJSON.md index 4b811f49e..73c2fc303 100644 --- a/docs/content/en/commands/hugo_convert_toJSON.md +++ b/docs/content/en/commands/hugo_convert_toJSON.md @@ -31,6 +31,7 @@ hugo convert toJSON [flags] [args] --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/docs/content/en/commands/hugo_convert_toTOML.md b/docs/content/en/commands/hugo_convert_toTOML.md index 19d847e90..9141eb1a2 100644 --- a/docs/content/en/commands/hugo_convert_toTOML.md +++ b/docs/content/en/commands/hugo_convert_toTOML.md @@ -31,6 +31,7 @@ hugo convert toTOML [flags] [args] --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/docs/content/en/commands/hugo_convert_toYAML.md b/docs/content/en/commands/hugo_convert_toYAML.md index 1785d3ad8..a932921cf 100644 --- a/docs/content/en/commands/hugo_convert_toYAML.md +++ b/docs/content/en/commands/hugo_convert_toYAML.md @@ -31,6 +31,7 @@ hugo convert toYAML [flags] [args] --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/docs/content/en/commands/hugo_env.md b/docs/content/en/commands/hugo_env.md index 296e6e002..e001c6098 100644 --- a/docs/content/en/commands/hugo_env.md +++ b/docs/content/en/commands/hugo_env.md @@ -30,6 +30,7 @@ hugo env [flags] [args] --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/docs/content/en/commands/hugo_gen.md b/docs/content/en/commands/hugo_gen.md index 71c6dfe42..b589e2e0f 100644 --- a/docs/content/en/commands/hugo_gen.md +++ b/docs/content/en/commands/hugo_gen.md @@ -26,6 +26,7 @@ hugo gen [command] [flags] --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/docs/content/en/commands/hugo_gen_chromastyles.md b/docs/content/en/commands/hugo_gen_chromastyles.md index 9c41f7174..5ea23381d 100644 --- a/docs/content/en/commands/hugo_gen_chromastyles.md +++ b/docs/content/en/commands/hugo_gen_chromastyles.md @@ -35,6 +35,7 @@ hugo gen chromastyles [flags] [args] --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/docs/content/en/commands/hugo_gen_doc.md b/docs/content/en/commands/hugo_gen_doc.md index 59999fb7b..16593400a 100644 --- a/docs/content/en/commands/hugo_gen_doc.md +++ b/docs/content/en/commands/hugo_gen_doc.md @@ -36,6 +36,7 @@ hugo gen doc [flags] [args] --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/docs/content/en/commands/hugo_gen_man.md b/docs/content/en/commands/hugo_gen_man.md index f2c40d71d..3602dcc93 100644 --- a/docs/content/en/commands/hugo_gen_man.md +++ b/docs/content/en/commands/hugo_gen_man.md @@ -33,6 +33,7 @@ hugo gen man [flags] [args] --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/docs/content/en/commands/hugo_import.md b/docs/content/en/commands/hugo_import.md index c9774f466..ad4907d58 100644 --- a/docs/content/en/commands/hugo_import.md +++ b/docs/content/en/commands/hugo_import.md @@ -32,6 +32,7 @@ hugo import [command] [flags] --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/docs/content/en/commands/hugo_import_jekyll.md b/docs/content/en/commands/hugo_import_jekyll.md index 4e4876d90..10d603bdf 100644 --- a/docs/content/en/commands/hugo_import_jekyll.md +++ b/docs/content/en/commands/hugo_import_jekyll.md @@ -33,6 +33,7 @@ hugo import jekyll [flags] [args] --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/docs/content/en/commands/hugo_list_all.md b/docs/content/en/commands/hugo_list_all.md index 5ac8a7c35..8edd0a4d9 100644 --- a/docs/content/en/commands/hugo_list_all.md +++ b/docs/content/en/commands/hugo_list_all.md @@ -30,6 +30,7 @@ hugo list all [flags] [args] --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/docs/content/en/commands/hugo_list_drafts.md b/docs/content/en/commands/hugo_list_drafts.md index 601c7648f..5ec870a5d 100644 --- a/docs/content/en/commands/hugo_list_drafts.md +++ b/docs/content/en/commands/hugo_list_drafts.md @@ -30,6 +30,7 @@ hugo list drafts [flags] [args] --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/docs/content/en/commands/hugo_list_expired.md b/docs/content/en/commands/hugo_list_expired.md index 47a9cc369..3feae5640 100644 --- a/docs/content/en/commands/hugo_list_expired.md +++ b/docs/content/en/commands/hugo_list_expired.md @@ -30,6 +30,7 @@ hugo list expired [flags] [args] --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/docs/content/en/commands/hugo_list_future.md b/docs/content/en/commands/hugo_list_future.md index 5cbb86c74..5b331b90b 100644 --- a/docs/content/en/commands/hugo_list_future.md +++ b/docs/content/en/commands/hugo_list_future.md @@ -30,6 +30,7 @@ hugo list future [flags] [args] --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/docs/content/en/commands/hugo_mod_clean.md b/docs/content/en/commands/hugo_mod_clean.md index ad97610cd..922fab2ab 100644 --- a/docs/content/en/commands/hugo_mod_clean.md +++ b/docs/content/en/commands/hugo_mod_clean.md @@ -32,6 +32,7 @@ hugo mod clean [flags] [args] --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/docs/content/en/commands/hugo_mod_get.md b/docs/content/en/commands/hugo_mod_get.md index 21fa1f967..d0d0f85d3 100644 --- a/docs/content/en/commands/hugo_mod_get.md +++ b/docs/content/en/commands/hugo_mod_get.md @@ -56,6 +56,7 @@ hugo mod get [flags] [args] --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/docs/content/en/commands/hugo_mod_graph.md b/docs/content/en/commands/hugo_mod_graph.md index 79ff3170f..da72a2a31 100644 --- a/docs/content/en/commands/hugo_mod_graph.md +++ b/docs/content/en/commands/hugo_mod_graph.md @@ -33,6 +33,7 @@ hugo mod graph [flags] [args] --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/docs/content/en/commands/hugo_mod_init.md b/docs/content/en/commands/hugo_mod_init.md index ad4501b64..7d5f77aa7 100644 --- a/docs/content/en/commands/hugo_mod_init.md +++ b/docs/content/en/commands/hugo_mod_init.md @@ -37,6 +37,7 @@ hugo mod init [flags] [args] --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/docs/content/en/commands/hugo_mod_npm.md b/docs/content/en/commands/hugo_mod_npm.md index 8e13a7294..12ec71b77 100644 --- a/docs/content/en/commands/hugo_mod_npm.md +++ b/docs/content/en/commands/hugo_mod_npm.md @@ -30,6 +30,7 @@ hugo mod npm [command] [flags] --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/docs/content/en/commands/hugo_mod_npm_pack.md b/docs/content/en/commands/hugo_mod_npm_pack.md index aadac772b..b923db82c 100644 --- a/docs/content/en/commands/hugo_mod_npm_pack.md +++ b/docs/content/en/commands/hugo_mod_npm_pack.md @@ -40,6 +40,7 @@ hugo mod npm pack [flags] [args] --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/docs/content/en/commands/hugo_mod_tidy.md b/docs/content/en/commands/hugo_mod_tidy.md index 9c665f1c5..63cb52ca6 100644 --- a/docs/content/en/commands/hugo_mod_tidy.md +++ b/docs/content/en/commands/hugo_mod_tidy.md @@ -26,6 +26,7 @@ hugo mod tidy [flags] [args] --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/docs/content/en/commands/hugo_mod_vendor.md b/docs/content/en/commands/hugo_mod_vendor.md index 42c04609a..9d9943c8a 100644 --- a/docs/content/en/commands/hugo_mod_vendor.md +++ b/docs/content/en/commands/hugo_mod_vendor.md @@ -32,6 +32,7 @@ hugo mod vendor [flags] [args] --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/docs/content/en/commands/hugo_mod_verify.md b/docs/content/en/commands/hugo_mod_verify.md index 9cddcbc25..dd41f29fd 100644 --- a/docs/content/en/commands/hugo_mod_verify.md +++ b/docs/content/en/commands/hugo_mod_verify.md @@ -31,6 +31,7 @@ hugo mod verify [flags] [args] --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/docs/content/en/commands/hugo_version.md b/docs/content/en/commands/hugo_version.md index b78237bb7..35b720153 100644 --- a/docs/content/en/commands/hugo_version.md +++ b/docs/content/en/commands/hugo_version.md @@ -30,6 +30,7 @@ hugo version [flags] [args] --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/docs/content/en/content-management/cross-references.md b/docs/content/en/content-management/cross-references.md index 00fb2d973..a2b3f8e1c 100644 --- a/docs/content/en/content-management/cross-references.md +++ b/docs/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/docs/content/en/content-management/front-matter.md b/docs/content/en/content-management/front-matter.md index 78d3323dd..062288320 100644 --- a/docs/content/en/content-management/front-matter.md +++ b/docs/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/docs/content/en/content-management/image-processing/index.md b/docs/content/en/content-management/image-processing/index.md index 0043f97b0..3d70951b3 100644 --- a/docs/content/en/content-management/image-processing/index.md +++ b/docs/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/docs/content/en/content-management/menus.md b/docs/content/en/content-management/menus.md index 369938aba..07bf41669 100644 --- a/docs/content/en/content-management/menus.md +++ b/docs/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/docs/content/en/content-management/multilingual.md b/docs/content/en/content-management/multilingual.md index f1f25086a..71adc214d 100644 --- a/docs/content/en/content-management/multilingual.md +++ b/docs/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/docs/content/en/content-management/page-resources.md b/docs/content/en/content-management/page-resources.md index 4bbd159be..54494c2e1 100644 --- a/docs/content/en/content-management/page-resources.md +++ b/docs/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/docs/content/en/content-management/related.md b/docs/content/en/content-management/related.md index 823e3035c..e80c0f06b 100644 --- a/docs/content/en/content-management/related.md +++ b/docs/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/docs/content/en/content-management/shortcodes.md b/docs/content/en/content-management/shortcodes.md index 35ffc390f..b2c98fc65 100644 --- a/docs/content/en/content-management/shortcodes.md +++ b/docs/content/en/content-management/shortcodes.md @@ -225,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/docs/content/en/content-management/static-files.md b/docs/content/en/content-management/static-files.md index 6bff7fd6f..ddc35da36 100644 --- a/docs/content/en/content-management/static-files.md +++ b/docs/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/docs/content/en/content-management/taxonomies.md b/docs/content/en/content-management/taxonomies.md index fe42a0667..a532e1873 100644 --- a/docs/content/en/content-management/taxonomies.md +++ b/docs/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"] {{ code-toggle >}} @@ -113,7 +113,7 @@ Custom taxonomies other than the [defaults](#default-taxonomies) must be defined While adding custom taxonomies, you need to put in the default taxonomies too, _if you want to keep them_. {{% /note %}} -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [taxonomies] tag = "tags" category = "categories" @@ -124,7 +124,7 @@ While adding custom taxonomies, you need to put in the default taxonomies too, _ If you want to have just the default `tags` taxonomy, and remove the `categories` taxonomy for your site, you can do so by modifying the `taxonomies` value in your [site config][config]. -{{< code-toggle file="config" copy=false >}} +{{< code-toggle file="hugo" copy=false >}} [taxonomies] tag = "tags" {{ code-toggle >}} diff --git a/docs/content/en/content-management/urls.md b/docs/content/en/content-management/urls.md index c65d6c15a..48de64966 100644 --- a/docs/content/en/content-management/urls.md +++ b/docs/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/docs/content/en/contribute/documentation.md b/docs/content/en/contribute/documentation.md index b1fed4cb2..4583f7cf4 100644 --- a/docs/content/en/contribute/documentation.md +++ b/docs/content/en/contribute/documentation.md @@ -128,7 +128,7 @@ fm #### Site configuration example ```text -{{* code-toggle file="config" */>}} +{{* code-toggle file="hugo" */>}} baseURL = 'https://example.org' languageCode = 'en-US' title = "Example Site" @@ -137,7 +137,7 @@ title = "Example Site" Rendered: -{{< code-toggle file="config" >}} +{{< code-toggle file="hugo" >}} baseURL = 'https://example.org' languageCode = 'en-US' title = "Example Site" diff --git a/docs/content/en/functions/hugo.md b/docs/content/en/functions/hugo.md index 998c71c37..78d658c66 100644 --- a/docs/content/en/functions/hugo.md +++ b/docs/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 -