From dac929a357b51a93ca151bb3647512e7c4ed0864 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Mon, 23 Feb 2026 09:42:12 -0800 Subject: [PATCH 1/2] content: Miscellaneous edits --- content/en/functions/resources/GetRemote.md | 14 +++++++------- content/en/getting-started/quick-start.md | 2 +- content/en/quick-reference/glossary/build.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/content/en/functions/resources/GetRemote.md b/content/en/functions/resources/GetRemote.md index 0346da5180..687ae6e1e1 100644 --- a/content/en/functions/resources/GetRemote.md +++ b/content/en/functions/resources/GetRemote.md @@ -10,10 +10,11 @@ params: signatures: ['resources.GetRemote URL [OPTIONS]'] --- -> [!NOTE] -> The `Err` method on the returned resource was removed in v0.141.0. -> -> Use the [`try`] statement instead, as shown in the [error handling] example below. +{{< new-in 0.141.0 >}} +The `Err` method on the returned resource was removed in v0.141.0. + +Use the [`try`](/functions/go-template/try) statement instead, as shown in the [error handling](#error-handling) example below. +{{< /new-in >}} ```go-html-template {{ $url := "https://example.org/images/a.jpg" }} @@ -217,9 +218,8 @@ Note that the entry above is: - An _addition_ to the allowlist; it does not _replace_ the allowlist - An array of [regular expressions](g) -[allowlist]: https://en.wikipedia.org/wiki/Whitelist -[Content-Type]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type - [`try`]: /functions/go-template/try +[allowlist]: https://en.wikipedia.org/wiki/Whitelist [configure file caches]: /configuration/caches/ +[Content-Type]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type [error handling]: #error-handling diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index 03c47e2799..f425a73be1 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -83,7 +83,7 @@ Clone the [Ananke][] theme into the `themes` directory, adding it to your projec git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke ``` -Append a line to the project configuration file, indicating the current theme. +Append a line to your project configuration file, indicating the current theme. ```text echo "theme = 'ananke'" >> hugo.toml diff --git a/content/en/quick-reference/glossary/build.md b/content/en/quick-reference/glossary/build.md index cbfc021fe3..4d4f73cb4b 100644 --- a/content/en/quick-reference/glossary/build.md +++ b/content/en/quick-reference/glossary/build.md @@ -2,4 +2,4 @@ title: build --- -To _build_ (verb) is to generate the static files for a [_project_](g), including HTML, images, CSS, and JavaScript. This process involves rendering templates, transforming resources, and resolving the matrix of [_language_](g), [_role_](g), and [_version_](g) defined in the project configuration. +To _build_ (verb) is to generate the static files for a [_project_](g), including HTML, images, CSS, and JavaScript. This process involves rendering templates, transforming resources, and resolving the matrix of [_language_](g), [_role_](g), and [_version_](g) defined in your project configuration. From ecf922df7cfed2b1145a9625f7cbc44d68cde47c Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Mon, 23 Feb 2026 20:35:24 -0800 Subject: [PATCH 2/2] content: Rename site configuration to project configuration (phase 2) --- .../en/_common/menu-entries/pre-and-post.md | 2 +- .../en/_common/methods/page/next-and-prev.md | 4 +- .../page/nextinsection-and-previnsection.md | 4 +- .../methods/resource/processing-spec.md | 14 +++--- .../methods/taxonomy/get-a-taxonomy-object.md | 2 +- .../_common/ref-and-relref-error-handling.md | 2 +- content/en/configuration/front-matter.md | 4 +- content/en/configuration/introduction.md | 10 ++--- content/en/configuration/languages.md | 2 +- content/en/configuration/markup.md | 4 +- content/en/configuration/menus.md | 8 ++-- content/en/configuration/output-formats.md | 6 +-- content/en/configuration/page.md | 2 +- content/en/configuration/permalinks.md | 2 +- content/en/configuration/related-content.md | 4 +- content/en/configuration/security.md | 2 +- content/en/configuration/taxonomies.md | 2 +- .../en/content-management/content-adapters.md | 4 +- content/en/content-management/formats.md | 4 +- content/en/content-management/front-matter.md | 8 ++-- .../image-processing/index.md | 4 +- .../content-management/markdown-attributes.md | 2 +- content/en/content-management/mathematics.md | 12 ++--- content/en/content-management/menus.md | 6 +-- content/en/content-management/multilingual.md | 12 ++--- .../en/content-management/page-resources.md | 4 +- content/en/content-management/summaries.md | 2 +- .../content-management/syntax-highlighting.md | 4 +- content/en/content-management/urls.md | 6 +-- content/en/contribute/documentation.md | 8 ++-- content/en/functions/collections/IsSet.md | 2 +- content/en/functions/collections/Querify.md | 2 +- content/en/functions/collections/Sort.md | 4 +- content/en/functions/collections/Where.md | 4 +- content/en/functions/css/TailwindCSS.md | 2 +- content/en/functions/fmt/Erroridf.md | 4 +- content/en/functions/fmt/Warnidf.md | 4 +- content/en/functions/hugo/Sites.md | 2 +- content/en/functions/images/Mask.md | 4 +- content/en/functions/js/Babel.md | 2 +- content/en/functions/lang/Translate.md | 6 +-- content/en/functions/os/Getenv.md | 2 +- .../functions/resources/ExecuteAsTemplate.md | 4 +- content/en/functions/resources/GetRemote.md | 2 +- content/en/functions/strings/Title.md | 4 +- content/en/functions/templates/Current.md | 2 +- content/en/functions/time/AsTime.md | 4 +- content/en/functions/time/Format.md | 4 +- content/en/functions/transform/Highlight.md | 4 +- content/en/functions/transform/ToMath.md | 2 +- content/en/functions/urls/AbsLangURL.md | 8 ++-- content/en/functions/urls/AbsURL.md | 6 +-- content/en/functions/urls/Anchorize.md | 2 +- content/en/functions/urls/RelLangURL.md | 8 ++-- content/en/functions/urls/RelURL.md | 6 +-- content/en/functions/urls/URLize.md | 2 +- .../en/getting-started/directory-structure.md | 44 +++++++++---------- content/en/getting-started/quick-start.md | 4 +- content/en/getting-started/usage.md | 10 ++--- .../deploy-with-hugo-deploy.md | 4 +- .../host-on-github-pages/index.md | 2 +- .../host-and-deploy/host-on-gitlab-pages.md | 2 +- .../host-on-sourcehut-pages.md | 2 +- content/en/hugo-modules/use-modules.md | 6 +-- content/en/methods/menu-entry/Children.md | 2 +- content/en/methods/menu-entry/HasChildren.md | 2 +- content/en/methods/menu-entry/Name.md | 14 +++--- content/en/methods/menu-entry/PageRef.md | 6 +-- content/en/methods/menu-entry/Params.md | 6 +-- content/en/methods/menu-entry/Weight.md | 12 ++--- content/en/methods/output-format/Rel.md | 2 +- content/en/methods/page/Aliases.md | 2 +- content/en/methods/page/AllTranslations.md | 2 +- content/en/methods/page/Data.md | 2 +- content/en/methods/page/Date.md | 2 +- content/en/methods/page/Draft.md | 2 +- content/en/methods/page/Fragments.md | 2 +- content/en/methods/page/GitInfo.md | 6 +-- content/en/methods/page/HasMenuCurrent.md | 2 +- content/en/methods/page/IsMenuCurrent.md | 2 +- content/en/methods/page/IsTranslated.md | 2 +- content/en/methods/page/Paginate.md | 4 +- content/en/methods/page/Paginator.md | 4 +- content/en/methods/page/Sitemap.md | 2 +- content/en/methods/page/Sites.md | 2 +- content/en/methods/page/TableOfContents.md | 2 +- content/en/methods/page/Title.md | 4 +- content/en/methods/page/TranslationKey.md | 2 +- content/en/methods/page/Translations.md | 2 +- content/en/methods/pager/PagerSize.md | 4 +- content/en/methods/pages/ByDate.md | 4 +- content/en/methods/pages/ByExpiryDate.md | 4 +- content/en/methods/pages/ByLastmod.md | 4 +- content/en/methods/pages/ByParam.md | 2 +- content/en/methods/pages/ByPublishDate.md | 4 +- content/en/methods/pages/GroupByDate.md | 4 +- content/en/methods/pages/GroupByExpiryDate.md | 4 +- content/en/methods/pages/GroupByLastmod.md | 4 +- .../en/methods/pages/GroupByPublishDate.md | 4 +- content/en/methods/resource/Exif.md | 2 +- content/en/methods/resource/Meta.md | 6 +-- content/en/methods/site/BaseURL.md | 2 +- content/en/methods/site/BuildDrafts.md | 2 +- content/en/methods/site/Config.md | 4 +- content/en/methods/site/Copyright.md | 2 +- content/en/methods/site/LanguagePrefix.md | 2 +- content/en/methods/site/Languages.md | 4 +- content/en/methods/site/MainSections.md | 6 +-- content/en/methods/site/Param.md | 2 +- content/en/methods/site/Params.md | 4 +- content/en/methods/site/Role.md | 4 +- content/en/methods/site/Sites.md | 2 +- content/en/methods/site/Taxonomies.md | 2 +- content/en/methods/site/Title.md | 2 +- content/en/methods/site/Version.md | 4 +- .../glossary/canonical-output-format.md | 6 +-- .../en/quick-reference/glossary/glob-slice.md | 2 +- .../glossary/regular-expression.md | 2 +- .../syntax-highlighting-styles.md | 2 +- content/en/render-hooks/images.md | 6 +-- content/en/render-hooks/links.md | 4 +- content/en/render-hooks/passthrough.md | 2 +- content/en/shortcodes/figure.md | 2 +- content/en/shortcodes/highlight.md | 6 +-- content/en/shortcodes/instagram.md | 2 +- content/en/shortcodes/param.md | 2 +- content/en/shortcodes/vimeo.md | 2 +- content/en/shortcodes/x.md | 4 +- content/en/shortcodes/youtube.md | 2 +- content/en/templates/embedded.md | 8 ++-- content/en/templates/introduction.md | 4 +- content/en/templates/menu.md | 14 +++--- content/en/templates/pagination.md | 6 +-- content/en/templates/robots.md | 8 ++-- content/en/templates/rss.md | 6 +-- content/en/templates/sitemap.md | 2 +- content/en/troubleshooting/audit/index.md | 4 +- 137 files changed, 297 insertions(+), 297 deletions(-) diff --git a/content/en/_common/menu-entries/pre-and-post.md b/content/en/_common/menu-entries/pre-and-post.md index da3d584d17..9f101b4578 100644 --- a/content/en/_common/menu-entries/pre-and-post.md +++ b/content/en/_common/menu-entries/pre-and-post.md @@ -2,7 +2,7 @@ _comment: Do not remove front matter. --- -In this site configuration we enable rendering of [emoji shortcodes], and add emoji shortcodes before (pre) and after (post) each menu entry: +In this project configuration we enable rendering of [emoji shortcodes], and add emoji shortcodes before (pre) and after (post) each menu entry: {{< code-toggle file=hugo >}} enableEmoji = true diff --git a/content/en/_common/methods/page/next-and-prev.md b/content/en/_common/methods/page/next-and-prev.md index 27b069ddc0..75f120c023 100644 --- a/content/en/_common/methods/page/next-and-prev.md +++ b/content/en/_common/methods/page/next-and-prev.md @@ -53,8 +53,8 @@ When you visit page-2: - The `Prev` method points to page-3 - The `Next` method points to page-1 -To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [site configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. +To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [project configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. -[site configuration]: /configuration/page/ +[project configuration]: /configuration/page/ [`Next`]: /methods/pages/prev [`Prev`]: /methods/pages/prev diff --git a/content/en/_common/methods/page/nextinsection-and-previnsection.md b/content/en/_common/methods/page/nextinsection-and-previnsection.md index 005953324a..4ca8a4ac83 100644 --- a/content/en/_common/methods/page/nextinsection-and-previnsection.md +++ b/content/en/_common/methods/page/nextinsection-and-previnsection.md @@ -53,9 +53,9 @@ When you visit page-2: - The `PrevInSection` method points to page-3 - The `NextInSection` method points to page-1 -To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [site configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. +To reverse the meaning of _next_ and _previous_ you can change the sort direction in your [project configuration], or use the [`Next`] and [`Prev`] methods on a `Pages` object for more flexibility. -[site configuration]: /configuration/page/ +[project configuration]: /configuration/page/ [`Next`]: /methods/pages/prev [`Prev`]: /methods/pages/prev diff --git a/content/en/_common/methods/resource/processing-spec.md b/content/en/_common/methods/resource/processing-spec.md index 20b8f84982..226c0ba6d0 100644 --- a/content/en/_common/methods/resource/processing-spec.md +++ b/content/en/_common/methods/resource/processing-spec.md @@ -10,14 +10,14 @@ action : Specify one of `crop`, `fill`, `fit`, or `resize`. This is applicable to the [`Process`][] method and the [`images.Process`][] filter. If you specify an action, you must also provide dimensions. anchor -: The focal point used when cropping or filling an image. Valid options include `TopLeft`, `Top`, `TopRight`, `Left`, `Center`, `Right`, `BottomLeft`, `Bottom`, `BottomRight`, or `Smart`. The `Smart` option utilizes the [`smartcrop.js`][] library to identify the most interesting area of the image. This defaults to the [`anchor`][] parameter in your site configuration. +: The focal point used when cropping or filling an image. Valid options include `TopLeft`, `Top`, `TopRight`, `Left`, `Center`, `Right`, `BottomLeft`, `Bottom`, `BottomRight`, or `Smart`. The `Smart` option utilizes the [`smartcrop.js`][] library to identify the most interesting area of the image. This defaults to the [`anchor`][] parameter in your project configuration. background color -: The background color used when converting transparent images to formats that do not support transparency, such as PNG to JPEG. This color also fills the empty space created when rotating an image by a non-orthogonal angle if the space is not transparent and a background color is not specified in the processing specification. The value must be an RGB [hexadecimal color][]. This defaults to the [`bgColor`][] parameter in your site configuration. +: The background color used when converting transparent images to formats that do not support transparency, such as PNG to JPEG. This color also fills the empty space created when rotating an image by a non-orthogonal angle if the space is not transparent and a background color is not specified in the processing specification. The value must be an RGB [hexadecimal color][]. This defaults to the [`bgColor`][] parameter in your project configuration. compression : {{< new-in 0.153.5 />}} -: The encoding strategy used for the image. Options are `lossy` or `lossless`. Note that `lossless` is only supported by the WebP format. This defaults to the [`compression`][] parameter in your site configuration. +: The encoding strategy used for the image. Options are `lossy` or `lossless`. Note that `lossless` is only supported by the WebP format. This defaults to the [`compression`][] parameter in your project configuration. dimensions : The dimensions of the resulting image, in pixels. The format is `WIDTHxHEIGHT` where `WIDTH` and `HEIGHT` are whole numbers. When resizing an image, you may specify only the width (such as `600x`) or only the height (such as `x400`) for proportional scaling. Specifying both width and height when resizing an image may result in non-proportional scaling. When cropping, fitting, or filling, you must provide both width and height such as `600x400`. @@ -26,7 +26,7 @@ format : The format of the resulting image. Valid options include `bmp`, `gif`, `jpeg`, `png`, `tiff`, or `webp`. This defaults to the format of the source image. hint -: The encoding preset used when processing WebP images, equivalent to the `-preset` flag for the [`cwebp`][] CLI. Valid options include `drawing`, `icon`, `photo`, `picture`, or `text`. This defaults to the [`hint`][] parameter in your site configuration. +: The encoding preset used when processing WebP images, equivalent to the `-preset` flag for the [`cwebp`][] CLI. Valid options include `drawing`, `icon`, `photo`, `picture`, or `text`. This defaults to the [`hint`][] parameter in your project configuration. Value|Example :--|:-- @@ -37,10 +37,10 @@ hint `text`|Image that is primarily text quality -: The visual fidelity of the image, applicable to JPEG and WebP formats when using `lossy` compression. The format is `qQUALITY` where `QUALITY` is a whole number between `1` and `100`, inclusive. Lower numbers prioritize smaller file size, while higher numbers prioritize visual clarity. This defaults to the [`quality`][] parameter in your site configuration. +: The visual fidelity of the image, applicable to JPEG and WebP formats when using `lossy` compression. The format is `qQUALITY` where `QUALITY` is a whole number between `1` and `100`, inclusive. Lower numbers prioritize smaller file size, while higher numbers prioritize visual clarity. This defaults to the [`quality`][] parameter in your project configuration. resampling filter -: The algorithm used to calculate new pixels when resizing, fitting, or filling an image. Common options include `box`, `lanczos`, `catmullRom`, `mitchellNetravali`, `linear`, or `nearestNeighbor`. This defaults to the [`resampleFilter`][] parameter in your site configuration. +: The algorithm used to calculate new pixels when resizing, fitting, or filling an image. Common options include `box`, `lanczos`, `catmullRom`, `mitchellNetravali`, `linear`, or `nearestNeighbor`. This defaults to the [`resampleFilter`][] parameter in your project configuration. Filter|Description :--|:-- @@ -56,7 +56,7 @@ resampling filter rotation : The number of whole degrees to rotate an image counter-clockwise. The format is `rDEGREES` where `DEGREES` is a whole number. Hugo performs rotation before any other transformations, so your [target dimensions](#dimensions) and any [anchor](#anchor) should refer to the image orientation after rotation. Use `r90`, `r180`, or `r270` for orthogonal rotations, or arbitrary angles such as `r45`. To rotate clockwise, use a negative number such as `r-45`. To automatically rotate an image based on its Exif orientation tag, use the [`images.AutoOrient`][] filter instead of manual rotation. - Rotating by non-orthogonal values increases the image extents to fit the rotated corners. For formats supporting alpha channels such as PNG or WebP, this resulting empty space is transparent by default. If the target format does not support transparency such as JPEG, or if you explicitly specify a [background color](#background-color) in the processing specification, the space is filled. If a color is required but not specified in the processing string, it defaults to the [`bgColor`][] parameter in your site configuration. + Rotating by non-orthogonal values increases the image extents to fit the rotated corners. For formats supporting alpha channels such as PNG or WebP, this resulting empty space is transparent by default. If the target format does not support transparency such as JPEG, or if you explicitly specify a [background color](#background-color) in the processing specification, the space is filled. If a color is required but not specified in the processing string, it defaults to the [`bgColor`][] parameter in your project configuration. [`anchor`]: /configuration/imaging/#anchor [`bgcolor`]: /configuration/imaging/#bgcolor diff --git a/content/en/_common/methods/taxonomy/get-a-taxonomy-object.md b/content/en/_common/methods/taxonomy/get-a-taxonomy-object.md index c902243383..75386145c9 100644 --- a/content/en/_common/methods/taxonomy/get-a-taxonomy-object.md +++ b/content/en/_common/methods/taxonomy/get-a-taxonomy-object.md @@ -6,7 +6,7 @@ Before we can use a `Taxonomy` method, we need to capture a `Taxonomy` object. ## Capture a Taxonomy object -Consider this site configuration: +Consider this project configuration: {{< code-toggle file=hugo >}} [taxonomies] diff --git a/content/en/_common/ref-and-relref-error-handling.md b/content/en/_common/ref-and-relref-error-handling.md index 1d67bbc1ff..9ec185d09e 100644 --- a/content/en/_common/ref-and-relref-error-handling.md +++ b/content/en/_common/ref-and-relref-error-handling.md @@ -2,7 +2,7 @@ _comment: Do not remove front matter. --- -By default, Hugo will throw an error and fail the build if it cannot resolve the path. You can change this to a warning in your site configuration, and specify a URL to return when the path cannot be resolved. +By default, Hugo will throw an error and fail the build if it cannot resolve the path. You can change this to a warning in your project configuration, and specify a URL to return when the path cannot be resolved. {{< code-toggle file=hugo >}} refLinksErrorLevel = 'warning' diff --git a/content/en/configuration/front-matter.md b/content/en/configuration/front-matter.md index a2cffffbd3..e348f8578f 100644 --- a/content/en/configuration/front-matter.md +++ b/content/en/configuration/front-matter.md @@ -76,7 +76,7 @@ Hugo provides the following [tokens](g) to help you configure your front matter: Within the `YYYY-MM-DD-HH-MM-SS` format, the date and time values may be separated by any character including a space (e.g., `2025-02-01T14-30-00`). - Hugo resolves the extracted date to the [`timeZone`] defined in your site configuration, falling back to the system time zone. After extracting the date, Hugo uses the remaining part of the file name to generate the page's [`slug`], but only if you haven't already specified a slug in the page's front matter. + Hugo resolves the extracted date to the [`timeZone`] defined in your project configuration, falling back to the system time zone. After extracting the date, Hugo uses the remaining part of the file name to generate the page's [`slug`], but only if you haven't already specified a slug in the page's front matter. For example, if you name your file `2025-02-01-article.md`, Hugo will set the date to `2025-02-01` and the slug to `article`. @@ -85,7 +85,7 @@ Hugo provides the following [tokens](g) to help you configure your front matter: ## Example -Consider this site configuration: +Consider this project configuration: {{< code-toggle file=hugo >}} [frontmatter] diff --git a/content/en/configuration/introduction.md b/content/en/configuration/introduction.md index 7f5e9f9cfa..f4a60884c9 100644 --- a/content/en/configuration/introduction.md +++ b/content/en/configuration/introduction.md @@ -23,7 +23,7 @@ Only define settings that deviate from the defaults. A smaller configuration fil ## Configuration file -Create a site configuration file in the root of your project directory, naming it `hugo.toml`, `hugo.yaml`, or `hugo.json`, with that order of precedence. +Create a project configuration file in the root of your project directory, naming it `hugo.toml`, `hugo.yaml`, or `hugo.json`, with that order of precedence. ```text my-project/ @@ -31,7 +31,7 @@ my-project/ ``` > [!note] -> For versions v0.109.0 and earlier, the site configuration file was named `config`. While you can still use this name, it's recommended to switch to the newer naming convention, `hugo`. +> For versions v0.109.0 and earlier, the project configuration file was named `config`. While you can still use this name, it's recommended to switch to the newer naming convention, `hugo`. A simple example: @@ -63,7 +63,7 @@ hugo build --config a.toml,b.yaml,c.json ## Configuration directory -Instead of a single site configuration file, split your configuration by [environment](g), root configuration key, and language. For example: +Instead of a single project configuration file, split your configuration by [environment](g), root configuration key, and language. For example: ```text my-project/ @@ -131,7 +131,7 @@ my-project/ Considering the structure above, when running `hugo build --environment staging`, Hugo will use every setting from `config/_default` and merge `staging`'s on top of those. -Let's take an example to understand this better. Let's say you are using Google Analytics for your website. This requires you to specify a [Google tag ID] in your site configuration: +Let's take an example to understand this better. Let's say you are using Google Analytics for your website. This requires you to specify a [Google tag ID] in your project configuration: {{< code-toggle file=hugo >}} [services.googleAnalytics] @@ -260,7 +260,7 @@ HUGO_NUMWORKERMULTIPLIER ## Current configuration -Display the complete site configuration with: +Display the complete project configuration with: ```sh hugo config diff --git a/content/en/configuration/languages.md b/content/en/configuration/languages.md index a8c1f79769..0ad9d44c6b 100644 --- a/content/en/configuration/languages.md +++ b/content/en/configuration/languages.md @@ -92,7 +92,7 @@ The following configuration keys can be defined separately for each language: {{< per-lang-config-keys >}} -Any key not defined in a `languages` object will fall back to the global value in the root of the site configuration. +Any key not defined in a `languages` object will fall back to the global value in the root of your project configuration. ## Language keys diff --git a/content/en/configuration/markup.md b/content/en/configuration/markup.md index e3e6e8a928..0829f9db52 100644 --- a/content/en/configuration/markup.md +++ b/content/en/configuration/markup.md @@ -18,7 +18,7 @@ defaultMarkdownHandler = 'goldmark' Files with ending with `.md`, `.mdown`, or `.markdown` are processed as Markdown, unless you've explicitly set a different format using the `markup` field in your front matter. -To use a different renderer for Markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your site configuration. +To use a different renderer for Markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your project configuration. `defaultMarkdownHandler`|Renderer :--|:-- @@ -255,7 +255,7 @@ workingFolderCurrent Follow the steps below to enable syntax highlighting. Step 1 -: Set the `source-highlighter` attribute in your site configuration. For example: +: Set the `source-highlighter` attribute in your project configuration. For example: {{< code-toggle file=hugo >}} [markup.asciidocExt.attributes] diff --git a/content/en/configuration/menus.md b/content/en/configuration/menus.md index 6b27e966b2..6eae4f2682 100644 --- a/content/en/configuration/menus.md +++ b/content/en/configuration/menus.md @@ -12,10 +12,10 @@ keywords: [] There are three ways to define menu entries: 1. [Automatically] -1. [In front matter] -1. In site configuration +1. In [front matter] +1. In your project configuration -This page covers the site configuration method. +This page covers the project configuration method. ## Example @@ -132,6 +132,6 @@ rel = 'external' [`Menus`]: /methods/site/menus/ [Automatically]: /content-management/menus/#define-automatically -[In front matter]: /content-management/menus/#define-in-front-matter +[front matter]: /content-management/menus/#define-in-front-matter [menu templates]: /templates/menu/ [menus]: /content-management/menus/ diff --git a/content/en/configuration/output-formats.md b/content/en/configuration/output-formats.md index bf61b3d2e7..d3a10a4287 100644 --- a/content/en/configuration/output-formats.md +++ b/content/en/configuration/output-formats.md @@ -53,7 +53,7 @@ notAlternative : (`bool`) Whether to exclude this output format from the values returned by the [`AlternativeOutputFormats`][] method on a `Page` object. Default is `false`. noUgly -: (`bool`) Whether to disable ugly URLs for this output format when [`uglyURLs`][] are enabled in your site configuration. Default is `false`. +: (`bool`) Whether to disable ugly URLs for this output format when [`uglyURLs`][] are enabled in your project configuration. Default is `false`. path : (`string`) The first segment of the publication path for this output format. This path segment is relative to the root of your [`publishDir`][]. If omitted, Hugo will use the file's original content path for publishing. @@ -62,7 +62,7 @@ permalinkable : (`bool`) Whether to return the rendering output format rather than the main output format when invoking the [`Permalink`][] and [`RelPermalink`][] methods on a `Page` object. Along with [`isHTML`](#ishtml), this must be `true` to create [alias redirects][]. Enabled by default for the `html` and `amp` output formats. Default is `false`. protocol -: (`string`) The protocol (scheme) of the URL for this output format. For example, `https://` or `webcal://`. Default is the scheme of the [`baseURL`][] parameter in your site configuration, typically `https://`. +: (`string`) The protocol (scheme) of the URL for this output format. For example, `https://` or `webcal://`. Default is the scheme of the [`baseURL`][] parameter in your project configuration, typically `https://`. rel : (`string`) The relationship of the output format to the current page. Hugo uses this property to determine the [canonical output format](g) of the current page. For the predefined `html` output format, the default value is `canonical`; for all other predefined output formats, the default value is `alternate`. @@ -71,7 +71,7 @@ root : (`bool`) Whether to publish files to the root of the publish directory. Default is `false`. ugly -: (`bool`) Whether to enable uglyURLs for this output format when `uglyURLs` is `false` in your site configuration. Default is `false`. +: (`bool`) Whether to enable uglyURLs for this output format when `uglyURLs` is `false` in your project configuration. Default is `false`. weight : (`int`) When set to a non-zero value, Hugo uses the `weight` as the first criteria when sorting output formats, falling back to the name of the output format. Lighter items float to the top, while heavier items sink to the bottom. Hugo renders output formats sequentially based on the sort order. Default is `0`, except for the `html` output format, which has a default weight of `10`. diff --git a/content/en/configuration/page.md b/content/en/configuration/page.md index 81169e5468..9012c928b2 100644 --- a/content/en/configuration/page.md +++ b/content/en/configuration/page.md @@ -15,7 +15,7 @@ Hugo uses the default sort order to determine the _next_ and _previous_ page rel - [`Next`](/methods/page/next/) and [`Prev`](/methods/page/prev/) - [`NextInSection`](/methods/page/nextinsection/) and [`PrevInSection`](/methods/page/previnsection/) -This is based on this default site configuration: +This is based on this default project configuration: {{< code-toggle config=page />}} diff --git a/content/en/configuration/permalinks.md b/content/en/configuration/permalinks.md index 0810624a67..cd1c38083f 100644 --- a/content/en/configuration/permalinks.md +++ b/content/en/configuration/permalinks.md @@ -97,7 +97,7 @@ content/ └── _index.md ``` -And this site configuration: +And this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' diff --git a/content/en/configuration/related-content.md b/content/en/configuration/related-content.md index 967c72a9a9..de8b33be47 100644 --- a/content/en/configuration/related-content.md +++ b/content/en/configuration/related-content.md @@ -9,7 +9,7 @@ keywords: [] > [!note] > To understand Hugo's related content identification, please refer to the [related content] page. -Hugo provides a sensible default configuration for identifying related content, but you can customize it in your site configuration, either globally or per language. +Hugo provides a sensible default configuration for identifying related content, but you can customize it in your project configuration, either globally or per language. ## Default configuration @@ -18,7 +18,7 @@ This is the default configuration: {{< code-toggle config=related />}} > [!note] -> Adding a `related` section to your site configuration requires you to provide a full configuration. You cannot override individual default values without specifying all related settings. +> Adding a `related` section to your project configuration requires you to provide a full configuration. You cannot override individual default values without specifying all related settings. ## Top-level options diff --git a/content/en/configuration/security.md b/content/en/configuration/security.md index f9eb91bd9b..54342ad513 100644 --- a/content/en/configuration/security.md +++ b/content/en/configuration/security.md @@ -36,7 +36,7 @@ http.urls > [!note] > Setting an allowlist to the string `none` will completely disable the associated feature. -You can also override the site configuration with environment variables. For example, to block `resources.GetRemote` from accessing any URL: +You can also override your project configuration with environment variables. For example, to block `resources.GetRemote` from accessing any URL: ```txt export HUGO_SECURITY_HTTP_URLS=none diff --git a/content/en/configuration/taxonomies.md b/content/en/configuration/taxonomies.md index fed1d4c5ea..5da0f7f4ca 100644 --- a/content/en/configuration/taxonomies.md +++ b/content/en/configuration/taxonomies.md @@ -56,7 +56,7 @@ taxonomies: tag: tags {{< /code-toggle >}} -To disable the taxonomy system, use the [`disableKinds`] setting in the root of your site configuration to disable the `taxonomy` and `term` page [kinds](g). +To disable the taxonomy system, use the [`disableKinds`] setting in the root of your project configuration to disable the `taxonomy` and `term` page [kinds](g). {{< code-toggle file=hugo >}} disableKinds = ['taxonomy','term'] diff --git a/content/en/content-management/content-adapters.md b/content/en/content-management/content-adapters.md index aed180f0ef..0af08d732c 100644 --- a/content/en/content-management/content-adapters.md +++ b/content/en/content-management/content-adapters.md @@ -282,7 +282,7 @@ With multilingual sites you can: ### Translations by file name -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [languages.en] @@ -305,7 +305,7 @@ content/ ### Translations by content directory -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [languages.en] diff --git a/content/en/content-management/formats.md b/content/en/content-management/formats.md index 14fb1fd4e8..0f9fe7f1cb 100644 --- a/content/en/content-management/formats.md +++ b/content/en/content-management/formats.md @@ -34,7 +34,7 @@ Hugo selects the content renderer based on the `markup` identifier in front matt Create your content in [Markdown] preceded by front matter. -Markdown is Hugo's default content format. Hugo natively renders Markdown to HTML using [Goldmark]. Goldmark is fast and conforms to the [CommonMark] and [GitHub Flavored Markdown] specifications. You can configure Goldmark in your [site configuration][configure goldmark]. +Markdown is Hugo's default content format. Hugo natively renders Markdown to HTML using [Goldmark]. Goldmark is fast and conforms to the [CommonMark] and [GitHub Flavored Markdown] specifications. You can configure Goldmark in your [project configuration][configure goldmark]. Hugo provides custom Markdown features including: @@ -77,7 +77,7 @@ Create your content in the [Emacs Org Mode] format preceded by front matter. You Create your content in the [AsciiDoc] format preceded by front matter. Hugo renders AsciiDoc content to HTML using the Asciidoctor executable. You must install Asciidoctor and its dependencies (Ruby) to render the AsciiDoc content format. -You can configure the AsciiDoc renderer in your [site configuration][configure asciidoc]. +You can configure the AsciiDoc renderer in your [project configuration][configure asciidoc]. In its default configuration, Hugo passes these CLI flags when calling the Asciidoctor executable: diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index 3f8bf7f1e8..c734789dfa 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -178,7 +178,7 @@ The embedded templates will skip a parameter if not provided in front matter, bu ## Taxonomies -Classify content by adding taxonomy terms to front matter. For example, with this site configuration: +Classify content by adding taxonomy terms to front matter. For example, with this project configuration: {{< code-toggle file=hugo >}} [taxonomies] @@ -293,7 +293,7 @@ kind = 'page' {{< /code-toggle >}} > [!note] -> For multilingual sites, defining cascade values in your site configuration is often more efficient. This avoids repeating the same cascade values on the home, section, taxonomy, or term page for each language. See [details](/configuration/cascade/). +> For multilingual sites, defining cascade values in your project configuration is often more efficient. This avoids repeating the same cascade values on the home, section, taxonomy, or term page for each language. See [details](/configuration/cascade/). > > If you choose to define cascade values in front matter for a multilingual site, you must create a corresponding home, section, taxonomy, or term page for every language. @@ -328,10 +328,10 @@ When populating a date field, whether a [custom page parameter](#parameters) or {{% include "/_common/parsable-date-time-strings.md" %}} -To override the default time zone, set the [`timeZone`](/configuration/all/#timezone) in your site configuration. The order of precedence for determining the time zone is: +To override the default time zone, set the [`timeZone`](/configuration/all/#timezone) in your project configuration. The order of precedence for determining the time zone is: 1. The time zone offset in the date/time string -1. The time zone specified in your site configuration +1. The time zone specified in your project configuration 1. The `Etc/UTC` time zone [`aliases`]: /methods/page/aliases/ diff --git a/content/en/content-management/image-processing/index.md b/content/en/content-management/image-processing/index.md index bf253afd1e..9df6222658 100644 --- a/content/en/content-management/image-processing/index.md +++ b/content/en/content-management/image-processing/index.md @@ -134,9 +134,9 @@ Select a method from the table above for syntax and usage examples. ### Caching -Hugo processes images on demand and returns a new resource object. To ensure subsequent builds remain fast, Hugo caches the results in the directory specified in the [file cache][] section of your site configuration. +Hugo processes images on demand and returns a new resource object. To ensure subsequent builds remain fast, Hugo caches the results in the directory specified in the [file cache][] section of your project configuration. -If you host your site with Netlify, include the following in your site configuration to persist the image cache between builds: +If you host your site with Netlify, include the following in your project configuration to persist the image cache between builds: ```toml [caches] diff --git a/content/en/content-management/markdown-attributes.md b/content/en/content-management/markdown-attributes.md index 6d695d67dc..42e7bcf944 100644 --- a/content/en/content-management/markdown-attributes.md +++ b/content/en/content-management/markdown-attributes.md @@ -38,7 +38,7 @@ With `class` and `id` attributes, whether you use long-form or short-form notati ## Block elements -Update your site configuration to enable Markdown attributes for block-level elements. +Update your project configuration to enable Markdown attributes for block-level elements. {{< code-toggle file=hugo >}} [markup.goldmark.parser.attribute] diff --git a/content/en/content-management/mathematics.md b/content/en/content-management/mathematics.md index b6fe8af570..6b86cac1c6 100644 --- a/content/en/content-management/mathematics.md +++ b/content/en/content-management/mathematics.md @@ -44,7 +44,7 @@ Whether an equation or expression appears inline, or as a block, depends on the Follow these instructions to include mathematical equations and expressions in your Markdown using LaTeX markup. Step 1 -: Enable and configure the Goldmark [passthrough extension][] in your site configuration. The passthrough extension preserves raw Markdown within delimited snippets of text, including the delimiters themselves. +: Enable and configure the Goldmark [passthrough extension][] in your project configuration. The passthrough extension preserves raw Markdown within delimited snippets of text, including the delimiters themselves. {{< code-toggle file=hugo copy=true >}} [markup.goldmark.extensions.passthrough] @@ -58,7 +58,7 @@ Step 1 math = true {{< /code-toggle >}} - The configuration above enables mathematical rendering on every page unless you set the `math` parameter to `false` in front matter. To enable mathematical rendering as needed, set the `math` parameter to `false` in your site configuration, and set the `math` parameter to `true` in front matter. Use this parameter in your base template as shown in [Step 3][]. + The configuration above enables mathematical rendering on every page unless you set the `math` parameter to `false` in front matter. To enable mathematical rendering as needed, set the `math` parameter to `false` in your project configuration, and set the `math` parameter to `true` in front matter. Use this parameter in your base template as shown in [Step 3][]. > [!note] > The configuration above precludes the use of the `$...$` delimiter pair for inline equations. Although you can add this delimiter pair to the configuration and JavaScript, you must double-escape the `$` symbol when used outside of math contexts to avoid unintended formatting. @@ -99,7 +99,7 @@ Step 2 ``` - The delimiters above must match the delimiters in your site configuration. + The delimiters above must match the delimiters in your project configuration. Step 3 : Conditionally call the _partial_ template from the base template. @@ -114,10 +114,10 @@ Step 3 ``` - The example above loads the _partial_ template if you have set the `math` parameter in front matter to `true`. If you have not set the `math` parameter in front matter, the conditional statement falls back to the `math` parameter in your site configuration. + The example above loads the _partial_ template if you have set the `math` parameter in front matter to `true`. If you have not set the `math` parameter in front matter, the conditional statement falls back to the `math` parameter in your project configuration. Step 4 -: If you set the `math` parameter to `false` in your site configuration, you must set the `math` parameter to `true` in front matter. For example: +: If you set the `math` parameter to `false` in your project configuration, you must set the `math` parameter to `true` in front matter. For example: {{< code-toggle file=content/math-examples.md fm=true >}} title = 'Math examples' @@ -211,7 +211,7 @@ To use KaTeX instead of MathJax, replace the _partial_ template from [Step 2][] ``` -The delimiters above must match the delimiters in your site configuration. +The delimiters above must match the delimiters in your project configuration. ## Chemistry diff --git a/content/en/content-management/menus.md b/content/en/content-management/menus.md index 8ff0597b3a..50920eefa0 100644 --- a/content/en/content-management/menus.md +++ b/content/en/content-management/menus.md @@ -20,14 +20,14 @@ There are three ways to define menu entries: 1. Automatically 1. In front matter -1. In site configuration +1. In your project configuration > [!note] > Although you can use these methods in combination when defining a menu, the menu will be easier to conceptualize and maintain if you use one method throughout the site. ## Define automatically -To automatically define a menu entry for each top-level [section](g) of your site, enable the section pages menu in your site configuration. +To automatically define a menu entry for each top-level [section](g) of your site, enable the section pages menu in your project configuration. {{< code-toggle file=hugo >}} sectionPagesMenu = "main" @@ -82,7 +82,7 @@ class = 'center' Access the entry with `site.Menus.main` in your templates. See [menu templates] for details. -## Define in site configuration +## Define in project configuration See [configure menus](/configuration/menus/). diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index 625bd7610e..ec31204c2d 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -253,8 +253,8 @@ See [lang.FormatPercent] for details. Localization of menu entries depends on how you define them: - When you define menu entries [automatically] using the section pages menu, you must use translation tables to localize each entry. -- When you define menu entries [in front matter], they are already localized based on the front matter itself. If the front matter values are insufficient, use translation tables to localize each entry. -- When you define menu entries [in site configuration], you must create language-specific menu entries under each language key. If the names of the menu entries are insufficient, use translation tables to localize each entry. +- When you define menu entries in [front matter], they are already localized based on the front matter itself. If the front matter values are insufficient, use translation tables to localize each entry. +- When you define menu entries in your [project configuration], you must create language-specific menu entries under each language key. If the names of the menu entries are insufficient, use translation tables to localize each entry. ### Create language-specific menu entries @@ -341,9 +341,9 @@ It queries the translation table for the current language using the menu entry's The `identifier` depends on how you define menu entries: - If you define the menu entry [automatically] using the section pages menu, the `identifier` is the page's `.Section`. -- If you define the menu entry [in site configuration] or [in front matter], set the `identifier` property to the desired value. +- If you define the menu entry in your [project configuration] or in [front matter], set the `identifier` property to the desired value. -For example, if you define menu entries in site configuration: +For example, if you define menu entries in project configuration: {{< code-toggle file=hugo >}} [[menus.main]] @@ -418,12 +418,12 @@ hugo new content content/de/post/test.md [config]: /configuration/ [configuration directory]: /configuration/introduction/#configuration-directory [example menu template]: /templates/menu/#example +[front matter]: /content-management/menus/#define-in-front-matter [i18func]: /functions/lang/translate/ -[in front matter]: /content-management/menus/#define-in-front-matter -[in site configuration]: /content-management/menus/#define-in-site-configuration [lang.FormatAccounting]: /functions/lang/formataccounting/ [lang.FormatCurrency]: /functions/lang/formatcurrency/ [lang.FormatNumber]: /functions/lang/formatnumber/ [lang.FormatNumberCustom]: /functions/lang/formatnumbercustom/ [lang.FormatPercent]: /functions/lang/formatpercent/ [lang.Merge]: /functions/lang/merge/ +[project configuration]: /content-management/menus/#define-in-project-configuration diff --git a/content/en/content-management/page-resources.md b/content/en/content-management/page-resources.md index c429d8af56..a915b5f744 100644 --- a/content/en/content-management/page-resources.md +++ b/content/en/content-management/page-resources.md @@ -198,7 +198,7 @@ By default, with a multilingual single-host site, Hugo does not duplicate shared > [!note] > This behavior is limited to Markdown content. Shared page resources for other [content formats] are copied into each language bundle. -Consider this site configuration: +Consider this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' @@ -278,7 +278,7 @@ This approach reduces build times, storage requirements, bandwidth consumption, > > You can also configure Hugo to `always` use the embedded link or image render hook, use it only as a `fallback`, or `never` use it. See [details](/configuration/markup/#renderhookslinkuseembedded). -Although duplicating shared page resources is inefficient, you can enable this feature in your site configuration if desired: +Although duplicating shared page resources is inefficient, you can enable this feature in your project configuration if desired: {{< code-toggle file=hugo >}} [markup.goldmark] diff --git a/content/en/content-management/summaries.md b/content/en/content-management/summaries.md index 93386eec2a..cd9eaa8361 100644 --- a/content/en/content-management/summaries.md +++ b/content/en/content-management/summaries.md @@ -84,7 +84,7 @@ This is the second paragraph. ## Automatic summary -If you do not define the summary manually or in front matter, Hugo automatically defines the summary based on the [`summaryLength`] in your site configuration. +If you do not define the summary manually or in front matter, Hugo automatically defines the summary based on the [`summaryLength`] in your project configuration. [`summaryLength`]: /configuration/all/#summarylength diff --git a/content/en/content-management/syntax-highlighting.md b/content/en/content-management/syntax-highlighting.md index 7e87efa49f..57735b0ab7 100644 --- a/content/en/content-management/syntax-highlighting.md +++ b/content/en/content-management/syntax-highlighting.md @@ -32,10 +32,10 @@ LANG : The language of the code to highlight. Choose from one of the [supported languages]. This value is case-insensitive. OPTIONS -: One or more space-separated or comma-separated key-value pairs wrapped in braces. Set default values for each option in your [site configuration]. The key names are case-insensitive. +: One or more space-separated or comma-separated key-value pairs wrapped in braces. Set default values for each option in your [project configuration]. The key names are case-insensitive. [supported languages]: #languages -[site configuration]: /configuration/markup/#highlight +[project configuration]: /configuration/markup/#highlight For example, with this Markdown: diff --git a/content/en/content-management/urls.md b/content/en/content-management/urls.md index eb55eea1cd..c1b4979e79 100644 --- a/content/en/content-management/urls.md +++ b/content/en/content-management/urls.md @@ -1,6 +1,6 @@ --- title: URL management -description: Control the structure and appearance of URLs through front matter entries and settings in your site configuration. +description: Control the structure and appearance of URLs through front matter entries and settings in your project configuration. categories: [] keywords: [] aliases: [/extras/permalinks/,/extras/aliases/,/extras/urls/,/doc/redirects/,/doc/alias/,/doc/aliases/] @@ -14,7 +14,7 @@ By default, when Hugo renders a page, the resulting URL matches the file path wi content/posts/post-1.md → https://example.org/posts/post-1/ ``` -You can change the structure and appearance of URLs with front matter values and site configuration options. +You can change the structure and appearance of URLs with front matter values and project configuration options. ## Front matter @@ -247,7 +247,7 @@ To implement this, you typically create a single template to generate the necess See the [`Aliases`][aliases_method] method page for a complete example of how to iterate through pages to generate these rules. -If you implement server-side redirects, you should disable the generation of individual HTML files by setting [`disableAliases`][] to `true` in your site configuration. This setting only prevents the generation of the physical HTML files; the `Aliases` method on a `Page` object remains available for use in your configuration templates. +If you implement server-side redirects, you should disable the generation of individual HTML files by setting [`disableAliases`][] to `true` in your project configuration. This setting only prevents the generation of the physical HTML files; the `Aliases` method on a `Page` object remains available for use in your configuration templates. [`baseURL`]: /configuration/all/#baseurl [`disableAliases`]: /configuration/all/#disablealiases diff --git a/content/en/contribute/documentation.md b/content/en/contribute/documentation.md index 39b0eb8306..2d878b020c 100644 --- a/content/en/contribute/documentation.md +++ b/content/en/contribute/documentation.md @@ -192,7 +192,7 @@ Field|Description|Required `params.minversion`|Applicable to the quick start page: the minimum Hugo version required|  `params.permalink`|Reserved for use by the news content adapter|  `params.reference (used in glossary term)`|Applicable to glossary entries: a URL for additional information|  -`params.searchable`|Whether to add the content of this page to the search index. The default value is cascaded down from the site configuration; `true` if the page kind is `page`, and `false` if the page kind is one of `home`, `section`, `taxonomy`, or `term`. Add this field to override the default value.|  +`params.searchable`|Whether to add the content of this page to the search index. The default value is cascaded down from the project configuration; `true` if the page kind is `page`, and `false` if the page kind is one of `home`, `section`, `taxonomy`, or `term`. Add this field to override the default value.|  `params.show_publish_date`|Whether to show the `publishDate` when rendering the page|  `weight`|The page weight|  `aliases`|Previous URLs used to access this page|  @@ -293,7 +293,7 @@ Use this syntax : ### Project configuration -Use the [code-toggle shortcode](#code-toggle) to include site configuration examples: +Use the [code-toggle shortcode](#code-toggle) to include project configuration examples: ```text {{}} @@ -371,7 +371,7 @@ These shortcodes are commonly used throughout the documentation. Other shortcode ### code-toggle -Use the `code-toggle` shortcode to display examples of site configuration, front matter, or data files. This shortcode takes these arguments: +Use the `code-toggle` shortcode to display examples of project configuration, front matter, or data files. This shortcode takes these arguments: config : (`string`) The section of `hugo.Data.docs.config` to render. @@ -383,7 +383,7 @@ datakey: : (`string`) The section of `hugo.Data.docs` to render. file -: (`string`) The file name to display above the rendered code. Omit the file extension for site configuration examples. +: (`string`) The file name to display above the rendered code. Omit the file extension for project configuration examples. fm : (`bool`) Whether to render the code as front matter. Default is `false`. diff --git a/content/en/functions/collections/IsSet.md b/content/en/functions/collections/IsSet.md index 405aa92afe..9a37f355c7 100644 --- a/content/en/functions/collections/IsSet.md +++ b/content/en/functions/collections/IsSet.md @@ -11,7 +11,7 @@ params: aliases: [/functions/isset] --- -For example, consider this site configuration: +For example, consider this project configuration: {{< code-toggle file=hugo >}} [params] diff --git a/content/en/functions/collections/Querify.md b/content/en/functions/collections/Querify.md index a91393787d..53a30f094d 100644 --- a/content/en/functions/collections/Querify.md +++ b/content/en/functions/collections/Querify.md @@ -34,7 +34,7 @@ Hugo renders this to: Link ``` -You can also pass in a map from your site configuration or front matter. For example: +You can also pass in a map from your project configuration or front matter. For example: {{< code-toggle file=content/example.md fm=true >}} title = 'Example' diff --git a/content/en/functions/collections/Sort.md b/content/en/functions/collections/Sort.md index c48610923c..9a9ed4ac13 100644 --- a/content/en/functions/collections/Sort.md +++ b/content/en/functions/collections/Sort.md @@ -17,7 +17,7 @@ The `ORDER` may be either `asc` (ascending) or `desc` (descending). The default ## Sort a slice -The examples below assume this site configuration: +The examples below assume this project configuration: {{< code-toggle file=hugo >}} [params] @@ -47,7 +47,7 @@ In the example above, `value` is the `KEY` representing the value of the slice e ## Sort a map -The examples below assume this site configuration: +The examples below assume this project configuration: {{< code-toggle file=hugo >}} [params.authors.a] diff --git a/content/en/functions/collections/Where.md b/content/en/functions/collections/Where.md index 6235a93eb0..3123b6a36b 100644 --- a/content/en/functions/collections/Where.md +++ b/content/en/functions/collections/Where.md @@ -264,13 +264,13 @@ Useful for theme authors, avoid hardcoding section names by using the `where` fu {{ $pages := where .Site.RegularPages "Section" "in" .Site.MainSections }} ``` -With this construct, a theme author can instruct users to specify their main sections in the site configuration: +With this construct, a theme author can instruct users to specify their main sections in their project configuration: {{< code-toggle file=hugo >}} mainSections = ['blog','galleries'] {{< /code-toggle >}} -If `mainSections` is not defined in the site configuration, the `MainSections` method returns a slice with one element---the top-level section with the most pages. +If `mainSections` is not defined in your project configuration, the `MainSections` method returns a slice with one element---the top-level section with the most pages. ## Boolean/undefined comparison diff --git a/content/en/functions/css/TailwindCSS.md b/content/en/functions/css/TailwindCSS.md index 739205066b..f6751a63a1 100644 --- a/content/en/functions/css/TailwindCSS.md +++ b/content/en/functions/css/TailwindCSS.md @@ -37,7 +37,7 @@ Step 1 [standalone executable]: https://github.com/tailwindlabs/tailwindcss/releases/latest Step 2 -: Add this to your site configuration: +: Add this to your project configuration: {{< code-toggle file=hugo copy=true >}} [build] diff --git a/content/en/functions/fmt/Erroridf.md b/content/en/functions/fmt/Erroridf.md index 97d628bac4..d6af48fd0f 100644 --- a/content/en/functions/fmt/Erroridf.md +++ b/content/en/functions/fmt/Erroridf.md @@ -13,7 +13,7 @@ aliases: [/functions/erroridf] {{% include "/_common/functions/fmt/format-string.md" %}} -The `erroridf` function evaluates the format string, then prints the result to the ERROR log and fails the build. Unlike the [`errorf`] function, you may suppress errors logged by the `erroridf` function by adding the message ID to the `ignoreLogs` array in your site configuration. +The `erroridf` function evaluates the format string, then prints the result to the ERROR log and fails the build. Unlike the [`errorf`] function, you may suppress errors logged by the `erroridf` function by adding the message ID to the `ignoreLogs` array in your project configuration. This template code: @@ -25,7 +25,7 @@ Produces this console log: ```text ERROR You should consider fixing this. -You can suppress this error by adding the following to your site configuration: +You can suppress this error by adding the following to your project configuration: ignoreLogs = ['error-42'] ``` diff --git a/content/en/functions/fmt/Warnidf.md b/content/en/functions/fmt/Warnidf.md index 7b68cd88b8..21fee29933 100644 --- a/content/en/functions/fmt/Warnidf.md +++ b/content/en/functions/fmt/Warnidf.md @@ -13,7 +13,7 @@ aliases: [/functions/warnidf] {{% include "/_common/functions/fmt/format-string.md" %}} -The `warnidf` function evaluates the format string, then prints the result to the WARNING log. Unlike the [`warnf`] function, you may suppress warnings logged by the `warnidf` function by adding the message ID to the `ignoreLogs` array in your site configuration. +The `warnidf` function evaluates the format string, then prints the result to the WARNING log. Unlike the [`warnf`] function, you may suppress warnings logged by the `warnidf` function by adding the message ID to the `ignoreLogs` array in your project configuration. This template code: @@ -25,7 +25,7 @@ Produces this console log: ```text WARN You should consider fixing this. -You can suppress this warning by adding the following to your site configuration: +You can suppress this warning by adding the following to your project configuration: ignoreLogs = ['warning-42'] ``` diff --git a/content/en/functions/hugo/Sites.md b/content/en/functions/hugo/Sites.md index 34ca7d1870..10a8e147ef 100644 --- a/content/en/functions/hugo/Sites.md +++ b/content/en/functions/hugo/Sites.md @@ -14,7 +14,7 @@ params: {{% include "/_common/functions/hugo/sites-collection.md" %}} -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' diff --git a/content/en/functions/images/Mask.md b/content/en/functions/images/Mask.md index 4f3b4aa3f1..ecc489d8a4 100644 --- a/content/en/functions/images/Mask.md +++ b/content/en/functions/images/Mask.md @@ -17,7 +17,7 @@ The `images.Mask` filter applies a mask to an image. Black pixels in the mask ma > [!note] > Of the formats supported by Hugo's imaging pipeline, only PNG and WebP have an alpha channel to support transparency. If your source image has a different format and you require transparent masked areas, convert it to either PNG or WebP as shown in the example below. -When applying a mask to a non-transparent image format such as JPEG, the masked areas will be filled with the color specified by the `bgColor` parameter in your [site configuration]. You can override that color with a `Process` image filter: +When applying a mask to a non-transparent image format such as JPEG, the masked areas will be filled with the color specified by the `bgColor` parameter in your [project configuration]. You can override that color with a `Process` image filter: ```go-html-template {{ $filter := images.Process "#00ff00" }} @@ -72,4 +72,4 @@ Mask [`Filter`]: /methods/resource/filter/ [`images.Filter`]: /functions/images/filter/ -[site configuration]: /configuration/imaging/ +[project configuration]: /configuration/imaging/ diff --git a/content/en/functions/js/Babel.md b/content/en/functions/js/Babel.md index 488c805033..2d76b67187 100644 --- a/content/en/functions/js/Babel.md +++ b/content/en/functions/js/Babel.md @@ -42,7 +42,7 @@ Step 2 ``` Step 3 -: Add the babel executable to Hugo's `security.exec.allow` list in your site configuration: +: Add the babel executable to Hugo's `security.exec.allow` list in your project configuration: {{< code-toggle file=hugo >}} [security.exec] diff --git a/content/en/functions/lang/Translate.md b/content/en/functions/lang/Translate.md index 555ede8b66..b73a760e19 100644 --- a/content/en/functions/lang/Translate.md +++ b/content/en/functions/lang/Translate.md @@ -18,9 +18,9 @@ If the key is not found in the translation table for the current language, the ` If the key is not found in the translation table for the `defaultContentLanguage`, the `lang.Translate` function returns an empty string. > [!note] -> To list missing and fallback translations, set [`printI18nWarnings`][] to `true` in your site configuration, or use the `--printI18nWarnings` flag when building your project. +> To list missing and fallback translations, set [`printI18nWarnings`][] to `true` in your project configuration, or use the `--printI18nWarnings` flag when building your project. > -> To render placeholders for missing and fallback translations, set [`enableMissingTranslationPlaceholders`][] to `true` in your site configuration. +> To render placeholders for missing and fallback translations, set [`enableMissingTranslationPlaceholders`][] to `true` in your project configuration. ## Translation tables @@ -31,7 +31,7 @@ i18n/en.toml i18n/pt-BR.toml ``` -The base name must match the [`languageCode`][] or [language key][] as defined in your site configuration. Hugo selects the translation table based on the `languageCode`, falling back to the language key if a matching translation table does not exist. +The base name must match the [`languageCode`][] or [language key][] as defined in your project configuration. Hugo selects the translation table based on the `languageCode`, falling back to the language key if a matching translation table does not exist. Artificial languages with private use subtags as defined in [RFC 5646 § 2.2.7][] are also supported. You may omit the `art-x-` prefix for brevity. For example: diff --git a/content/en/functions/os/Getenv.md b/content/en/functions/os/Getenv.md index c639b67a25..d9e6e08feb 100644 --- a/content/en/functions/os/Getenv.md +++ b/content/en/functions/os/Getenv.md @@ -18,7 +18,7 @@ By default, when using the `os.Getenv` function Hugo allows access to: - The `CI` environment variable - Any environment variable beginning with `HUGO_` -To access other environment variables, adjust your site configuration. For example, to allow access to the `HOME` and `USER` environment variables: +To access other environment variables, adjust your project configuration. For example, to allow access to the `HOME` and `USER` environment variables: {{< code-toggle file=hugo >}} [security.funcs] diff --git a/content/en/functions/resources/ExecuteAsTemplate.md b/content/en/functions/resources/ExecuteAsTemplate.md index bff83832e0..2ffb9dff71 100644 --- a/content/en/functions/resources/ExecuteAsTemplate.md +++ b/content/en/functions/resources/ExecuteAsTemplate.md @@ -14,7 +14,7 @@ The `resources.ExecuteAsTemplate` function returns a resource created from a Go Hugo publishes the resource to the target path when you call its [`Publish`], [`Permalink`], or [`RelPermalink`] methods. -Let's say you have a CSS file that you wish to populate with values from your site configuration: +Let's say you have a CSS file that you wish to populate with values from your project configuration: ```go-html-template {file="assets/css/template.css"} body { @@ -23,7 +23,7 @@ body { } ``` -And your site configuration contains: +And your project configuration contains: {{< code-toggle file=hugo >}} [params.style] diff --git a/content/en/functions/resources/GetRemote.md b/content/en/functions/resources/GetRemote.md index 687ae6e1e1..4d8ae0f82d 100644 --- a/content/en/functions/resources/GetRemote.md +++ b/content/en/functions/resources/GetRemote.md @@ -206,7 +206,7 @@ ERROR error calling resources.GetRemote: failed to resolve media type... For example, you will see the error above if you attempt to download an executable. -Although the allowlist contains entries for common media types, you may encounter situations where Hugo is unable to resolve the media type of a file that you know to be safe. In these situations, edit your site configuration to add the media type to the allowlist. For example: +Although the allowlist contains entries for common media types, you may encounter situations where Hugo is unable to resolve the media type of a file that you know to be safe. In these situations, edit your project configuration to add the media type to the allowlist. For example: {{< code-toggle file=hugo >}} [security.http] diff --git a/content/en/functions/strings/Title.md b/content/en/functions/strings/Title.md index d1b4aca016..0ff79cdf03 100644 --- a/content/en/functions/strings/Title.md +++ b/content/en/functions/strings/Title.md @@ -15,7 +15,7 @@ aliases: [/functions/title] {{ title "table of contents (TOC)" }} → Table of Contents (TOC) ``` -By default, Hugo follows the capitalization rules published in the [Associated Press Stylebook]. Change your [site configuration] if you would prefer to: +By default, Hugo follows the capitalization rules published in the [Associated Press Stylebook]. Change your [project configuration] if you would prefer to: - Follow the capitalization rules published in the [Chicago Manual of Style] - Capitalize the first letter of every word @@ -26,4 +26,4 @@ The last option is useful if your theme uses the `title` function, and you would [Associated Press Stylebook]: https://www.apstylebook.com/ [Chicago Manual of Style]: https://www.chicagomanualofstyle.org/home.html -[site configuration]: /configuration/all/#title-case-style +[project configuration]: /configuration/all/#title-case-style diff --git a/content/en/functions/templates/Current.md b/content/en/functions/templates/Current.md index b82818c47a..47adf38aec 100644 --- a/content/en/functions/templates/Current.md +++ b/content/en/functions/templates/Current.md @@ -36,7 +36,7 @@ Parent ## Examples -The examples below help visualize template execution and require a `debug` parameter set to `true` in your site configuration: +The examples below help visualize template execution and require a `debug` parameter set to `true` in your project configuration: {{< code-toggle file=hugo >}} [params] diff --git a/content/en/functions/time/AsTime.md b/content/en/functions/time/AsTime.md index 760329a13c..884d6c61b8 100644 --- a/content/en/functions/time/AsTime.md +++ b/content/en/functions/time/AsTime.md @@ -26,7 +26,7 @@ As shown above, the first argument must be a parsable string representation of a {{% include "/_common/parsable-date-time-strings.md" %}} -To override the default time zone, set the [`timeZone`] in your site configuration or provide a second argument to the `time.AsTime` function. For example: +To override the default time zone, set the [`timeZone`] in your project configuration or provide a second argument to the `time.AsTime` function. For example: ```go-html-template {{ time.AsTime "15 Oct 2023" "America/Los_Angeles" }} @@ -38,7 +38,7 @@ The order of precedence for determining the time zone is: 1. The time zone offset in the date/time string 1. The time zone provided as the second argument to the `time.AsTime` function -1. The time zone specified in your site configuration +1. The time zone specified in your project configuration 1. The `Etc/UTC` time zone [IANA Time Zone database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones diff --git a/content/en/functions/time/Format.md b/content/en/functions/time/Format.md index f1b0d6d839..112a6e72e3 100644 --- a/content/en/functions/time/Format.md +++ b/content/en/functions/time/Format.md @@ -29,10 +29,10 @@ Examples of parsable string representations: {{% include "/_common/parsable-date-time-strings.md" %}} -To override the default time zone, set the [`timeZone`] in your site configuration. The order of precedence for determining the time zone is: +To override the default time zone, set the [`timeZone`] in your project configuration. The order of precedence for determining the time zone is: 1. The time zone offset in the date/time string -1. The time zone specified in your site configuration +1. The time zone specified in your project configuration 1. The `Etc/UTC` time zone [`timeZone`]: /configuration/all/#timezone diff --git a/content/en/functions/transform/Highlight.md b/content/en/functions/transform/Highlight.md index 5633f2256d..1e4e235b4e 100644 --- a/content/en/functions/transform/Highlight.md +++ b/content/en/functions/transform/Highlight.md @@ -27,9 +27,9 @@ LANG : (`string`) The language of the code to highlight. Choose from one of the [supported languages]. This value is case-insensitive. OPTIONS -: (`map or string`) A map or comma-separated key-value pairs wrapped in quotation marks. Set default values for each option in your [site configuration]. The key names are case-insensitive. +: (`map or string`) A map or comma-separated key-value pairs wrapped in quotation marks. Set default values for each option in your [project configuration]. The key names are case-insensitive. -[site configuration]: /configuration/markup#highlight +[project configuration]: /configuration/markup#highlight [supported languages]: /content-management/syntax-highlighting#languages ## Examples diff --git a/content/en/functions/transform/ToMath.md b/content/en/functions/transform/ToMath.md index 97689f5d5d..27b2f0d705 100644 --- a/content/en/functions/transform/ToMath.md +++ b/content/en/functions/transform/ToMath.md @@ -99,7 +99,7 @@ The example below demonstrates error handing within a template. Instead of client-side JavaScript rendering of mathematical markup using MathJax or KaTeX, create a passthrough render hook which calls the `transform.ToMath` function. Step 1 -: Enable and configure the Goldmark [passthrough extension][] in your site configuration. The passthrough extension preserves raw Markdown within delimited snippets of text, including the delimiters themselves. +: Enable and configure the Goldmark [passthrough extension][] in your project configuration. The passthrough extension preserves raw Markdown within delimited snippets of text, including the delimiters themselves. [passthrough extension]: /configuration/markup/#passthrough diff --git a/content/en/functions/urls/AbsLangURL.md b/content/en/functions/urls/AbsLangURL.md index da45ca2245..b2cf021c32 100644 --- a/content/en/functions/urls/AbsLangURL.md +++ b/content/en/functions/urls/AbsLangURL.md @@ -14,10 +14,10 @@ aliases: [/functions/abslangurl] Use this function with both monolingual and multilingual configurations. The URL returned by this function depends on: - Whether the input begins with a slash (`/`) -- The `baseURL` in your site configuration +- The `baseURL` in your project configuration - The language prefix, if any -This is the site configuration for the examples that follow: +This is the project configuration for the examples that follow: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' @@ -30,7 +30,7 @@ weight = 2 ## Input does not begin with a slash -If the input does not begin with a slash, the path in the resulting URL will be relative to the `baseURL` in your site configuration. +If the input does not begin with a slash, the path in the resulting URL will be relative to the `baseURL` in your project configuration. When rendering the `en` site with `baseURL = https://example.org/` @@ -50,7 +50,7 @@ When rendering the `en` site with `baseURL = https://example.org/docs/` ## Input begins with a slash -If the input begins with a slash, the path in the resulting URL will be relative to the protocol+host of the `baseURL` in your site configuration. +If the input begins with a slash, the path in the resulting URL will be relative to the protocol+host of the `baseURL` in your project configuration. When rendering the `en` site with `baseURL = https://example.org/` diff --git a/content/en/functions/urls/AbsURL.md b/content/en/functions/urls/AbsURL.md index 72613cd0bf..e29862429d 100644 --- a/content/en/functions/urls/AbsURL.md +++ b/content/en/functions/urls/AbsURL.md @@ -14,11 +14,11 @@ aliases: [/functions/absurl] With multilingual configurations, use the [`urls.AbsLangURL`] function instead. The URL returned by this function depends on: - Whether the input begins with a slash (`/`) -- The `baseURL` in your site configuration +- The `baseURL` in your project configuration ## Input does not begin with a slash -If the input does not begin with a slash, the path in the resulting URL will be relative to the `baseURL` in your site configuration. +If the input does not begin with a slash, the path in the resulting URL will be relative to the `baseURL` in your project configuration. With `baseURL = https://example.org/` @@ -38,7 +38,7 @@ With `baseURL = https://example.org/docs/` ## Input begins with a slash -If the input begins with a slash, the path in the resulting URL will be relative to the protocol+host of the `baseURL` in your site configuration. +If the input begins with a slash, the path in the resulting URL will be relative to the protocol+host of the `baseURL` in your project configuration. With `baseURL = https://example.org/` diff --git a/content/en/functions/urls/Anchorize.md b/content/en/functions/urls/Anchorize.md index d18bd9a4d5..d529ec493a 100644 --- a/content/en/functions/urls/Anchorize.md +++ b/content/en/functions/urls/Anchorize.md @@ -15,7 +15,7 @@ aliases: [/functions/anchorize] ## Sanitizing logic -With the default Markdown renderer, Goldmark, the sanitizing logic is controlled by your site configuration: +With the default Markdown renderer, Goldmark, the sanitizing logic is controlled by your project configuration: {{< code-toggle file=hugo >}} [markup.goldmark.parser] diff --git a/content/en/functions/urls/RelLangURL.md b/content/en/functions/urls/RelLangURL.md index af8bff3d7a..ea3131672f 100644 --- a/content/en/functions/urls/RelLangURL.md +++ b/content/en/functions/urls/RelLangURL.md @@ -14,10 +14,10 @@ aliases: [/functions/rellangurl] Use this function with both monolingual and multilingual configurations. The URL returned by this function depends on: - Whether the input begins with a slash (`/`) -- The `baseURL` in your site configuration +- The `baseURL` in your project configuration - The language prefix, if any -This is the site configuration for the examples that follow: +This is the project configuration for the examples that follow: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' @@ -30,7 +30,7 @@ weight = 2 ## Input does not begin with a slash -If the input does not begin with a slash, the resulting URL will be relative to the `baseURL` in your site configuration. +If the input does not begin with a slash, the resulting URL will be relative to the `baseURL` in your project configuration. When rendering the `en` site with `baseURL = https://example.org/` @@ -60,7 +60,7 @@ When rendering the `en` site with `baseURL = https://example.org/docs/` ## Input begins with a slash -If the input begins with a slash, the resulting URL will be relative to the protocol+host of the `baseURL` in your site configuration. +If the input begins with a slash, the resulting URL will be relative to the protocol+host of the `baseURL` in your project configuration. When rendering the `en` site with `baseURL = https://example.org/` diff --git a/content/en/functions/urls/RelURL.md b/content/en/functions/urls/RelURL.md index 0aef4043f0..97328eb2ae 100644 --- a/content/en/functions/urls/RelURL.md +++ b/content/en/functions/urls/RelURL.md @@ -14,11 +14,11 @@ aliases: [/functions/relurl] With multilingual configurations, use the [`urls.RelLangURL`] function instead. The URL returned by this function depends on: - Whether the input begins with a slash (`/`) -- The `baseURL` in your site configuration +- The `baseURL` in your project configuration ## Input does not begin with a slash -If the input does not begin with a slash, the resulting URL will be relative to the `baseURL` in your site configuration. +If the input does not begin with a slash, the resulting URL will be relative to the `baseURL` in your project configuration. With `baseURL = https://example.org/` @@ -48,7 +48,7 @@ With `baseURL = https://example.org/docs/` ## Input begins with a slash -If the input begins with a slash, the resulting URL will be relative to the protocol+host of the `baseURL` in your site configuration. +If the input begins with a slash, the resulting URL will be relative to the protocol+host of the `baseURL` in your project configuration. With `baseURL = https://example.org/` diff --git a/content/en/functions/urls/URLize.md b/content/en/functions/urls/URLize.md index b0cc812ec1..28bc1dc47f 100644 --- a/content/en/functions/urls/URLize.md +++ b/content/en/functions/urls/URLize.md @@ -17,7 +17,7 @@ aliases: [/functions/urlize] Use the `urlize` function to create a link to a [term page](g). -Consider this site configuration: +Consider this project configuration: {{< code-toggle file=hugo >}} [taxonomies] diff --git a/content/en/getting-started/directory-structure.md b/content/en/getting-started/directory-structure.md index 01d7eddcfc..863775d992 100644 --- a/content/en/getting-started/directory-structure.md +++ b/content/en/getting-started/directory-structure.md @@ -7,20 +7,20 @@ weight: 30 aliases: [/overview/source-directory/] --- -Each Hugo project is a directory, with subdirectories that contribute to the content, structure, behavior, and presentation of your site. +Each Hugo project is a directory, with subdirectories that contribute to content, structure, behavior, and presentation. -## Site skeleton +## Project skeleton -Hugo generates a project skeleton when you create a new site. For example, this command: +Hugo generates a project skeleton when you create a new project. For example, this command: ```sh -hugo new site my-site +hugo new project my-project ``` Creates this directory structure: ```txt -my-site/ +my-project/ ├── archetypes/ │ └── default.md ├── assets/ @@ -30,17 +30,17 @@ my-site/ ├── layouts/ ├── static/ ├── themes/ -└── hugo.toml <-- site configuration +└── hugo.toml <-- project configuration ``` -Depending on requirements, you may wish to organize your site configuration into subdirectories: +Depending on requirements, you may wish to organize your project configuration into subdirectories: ```txt -my-site/ +my-project/ ├── archetypes/ │ └── default.md ├── assets/ -├── config/ <-- site configuration +├── config/ <-- project configuration │ └── _default/ │ └── hugo.toml ├── content/ @@ -51,10 +51,10 @@ my-site/ └── themes/ ``` -When you build your site, Hugo creates a `public` directory, and typically a `resources` directory as well: +When you build your project, Hugo creates a `public` directory, and typically a `resources` directory as well: ```txt -my-site/ +my-project/ ├── archetypes/ │ └── default.md ├── assets/ @@ -65,15 +65,15 @@ my-site/ ├── data/ ├── i18n/ ├── layouts/ -├── public/ <-- created when you build your site -├── resources/ <-- created when you build your site +├── public/ <-- created when you build your project +├── resources/ <-- created when you build your project ├── static/ └── themes/ ``` ## Directories -Each of the subdirectories contributes to the content, structure, behavior, or presentation of your site. +Each of the subdirectories contributes to content, structure, behavior, or presentation. archetypes : The `archetypes` directory contains templates for new content. See [details](/content-management/archetypes/). @@ -82,28 +82,28 @@ assets : The `assets` directory contains global resources typically passed through an asset pipeline. This includes resources such as images, CSS, Sass, JavaScript, and TypeScript. See [details](/hugo-pipes/introduction/). config -: The `config` directory contains your site configuration, possibly split into multiple subdirectories and files. For projects with minimal configuration or projects that do not need to behave differently in different environments, a single configuration file named `hugo.toml` in the root of the project is sufficient. See [details](/configuration/introduction/#configuration-directory). +: The `config` directory contains your project configuration, possibly split into multiple subdirectories and files. For projects with minimal configuration or projects that do not need to behave differently in different environments, a single configuration file named `hugo.toml` in the root of the project is sufficient. See [details](/configuration/introduction/#configuration-directory). content -: The `content` directory contains the markup files (typically Markdown) and page resources that comprise the content of your site. See [details](/content-management/organization/). +: The `content` directory contains the markup files (typically Markdown) and page resources that comprise the content of your project. See [details](/content-management/organization/). data : The `data` directory contains data files (JSON, TOML, YAML, or XML) that augment content, configuration, localization, and navigation. See [details](/content-management/data-sources/). i18n -: The `i18n` directory contains translation tables for multilingual sites. See [details](/content-management/multilingual/). +: The `i18n` directory contains translation tables for multilingual projects. See [details](/content-management/multilingual/). layouts : The `layouts` directory contains templates to transform content, data, and resources into a complete website. See [details](/templates/). public -: The `public` directory contains the published website, generated when you run the `hugo build` or `hugo server` commands. Hugo recreates this directory and its content as needed. See [details](/getting-started/usage/#build-your-site). +: The `public` directory contains the published website, generated when you run the `hugo build` or `hugo server` commands. Hugo recreates this directory and its content as needed. See [details](/getting-started/usage/#build-your-project). resources : The `resources` directory contains cached output from Hugo's asset pipelines, generated when you run the `hugo build` or `hugo server` commands. By default this cache directory includes CSS and images. Hugo recreates this directory and its content as needed. static -: The `static` directory contains files that will be copied to the `public` directory when you build your site. For example: `favicon.ico`, `robots.txt`, and files that verify site ownership. Before the introduction of [page bundles](g) and [asset pipelines](/hugo-pipes/introduction/), the `static` directory was also used for images, CSS, and JavaScript. +: The `static` directory contains files that will be copied to the `public` directory when you build your project. For example: `favicon.ico`, `robots.txt`, and files that verify website ownership. Before the introduction of [page bundles](g) and [asset pipelines](/hugo-pipes/introduction/), the `static` directory was also used for images, CSS, and JavaScript. themes : The `themes` directory contains one or more [themes](g), each in its own subdirectory. @@ -115,7 +115,7 @@ Hugo creates a union file system, allowing you to mount two or more directories ```text home/ └── user/ - ├── my-site/ + ├── my-project/ │ ├── content/ │ │ ├── books/ │ │ │ ├── _index.md @@ -132,7 +132,7 @@ home/ └── film-2.md ``` -You can include the shared content when you build your site using mounts. In your site configuration: +You can include the shared content using mounts. In your project configuration: {{< code-toggle file=hugo >}} [[module.mounts]] @@ -154,7 +154,7 @@ After mounting, the union file system has this structure: ```text home/ └── user/ - └── my-site/ + └── my-project/ ├── content/ │ ├── books/ │ │ ├── _index.md diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index f425a73be1..3d05333ba8 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -148,7 +148,7 @@ When satisfied with your new content, set the front matter `draft` parameter to ## Configure the project -With your editor, open the [project configuration][] file (`hugo.toml`) in the root of your project. +With your editor, open your [project configuration][] file (`hugo.toml`) in the root of your project. ```text baseURL = 'https://example.org/' @@ -210,7 +210,7 @@ For other resources to help you learn Hugo, including books and video tutorials, [Markdown]: https://daringfireball.net/projects/markdown [PowerShell]: https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows [project configuration]: /configuration/ -[project skeleton]: /getting-started/directory-structure/#site-skeleton +[project skeleton]: /getting-started/directory-structure/#project-skeleton [requesting help]: https://discourse.gohugo.io/t/requesting-help/9132 [specification]: https://spec.commonmark.org/ [The New Dynamic]: https://www.thenewdynamic.com/ diff --git a/content/en/getting-started/usage.md b/content/en/getting-started/usage.md index d1636d6500..41c703bfb4 100644 --- a/content/en/getting-started/usage.md +++ b/content/en/getting-started/usage.md @@ -35,15 +35,15 @@ To get help with a subcommand, use the `--help` flag. For example: hugo server --help ``` -## Build your site +## Build your project -To build your site, `cd` into your project directory and run: +To build your project, `cd` into your project directory and run: ```sh -hugo +hugo build ``` -The [`hugo build`] command builds your site, publishing the files to the `public` directory. To publish your site to a different directory, use the [`--destination`] flag or set [`publishDir`] in your site configuration. +The [`hugo build`] command builds your project, publishing the files to the `public` directory. To publish your project to a different directory, use the [`--destination`] flag or set [`publishDir`] in your project configuration. > [!note] > Hugo does not clear the `public` directory before building your project. Existing files are overwritten, but not deleted. This behavior is intentional to prevent the inadvertent removal of files that you may have added to the `public` directory after the build. @@ -70,7 +70,7 @@ hugo build --buildExpired # or -E hugo build --buildFuture # or -F ``` -Although you can also set these values in your site configuration, it can lead to unwanted results unless all content authors are aware of, and understand, the settings. +Although you can also set these values in your project configuration, it can lead to unwanted results unless all content authors are aware of, and understand, the settings. > [!note] > As noted above, Hugo does not clear the `public` directory before building your project. Depending on the _current_ evaluation of the four conditions above, after the build your `public` directory may contain extraneous files from a previous build. diff --git a/content/en/host-and-deploy/deploy-with-hugo-deploy.md b/content/en/host-and-deploy/deploy-with-hugo-deploy.md index bffaf4efeb..6dae734c46 100644 --- a/content/en/host-and-deploy/deploy-with-hugo-deploy.md +++ b/content/en/host-and-deploy/deploy-with-hugo-deploy.md @@ -31,7 +31,7 @@ Use the `hugo deploy` command to deploy your site Amazon S3, Azure Blob Storage, ## Configuration -Create a deployment target in your [site configuration]. The only required parameters are [`name`] and [`url`]: +Create a deployment target in your [project configuration]. The only required parameters are [`name`] and [`url`]: {{< code-toggle file=hugo >}} [deployment] @@ -94,4 +94,4 @@ See [configure deployment](/configuration/deployment/). [Google Cloud]: https://cloud.google.com/ [installation]: /installation/ [Quick Start]: /getting-started/quick-start/ -[site configuration]: /configuration/deployment/ +[project configuration]: /configuration/deployment/ diff --git a/content/en/host-and-deploy/host-on-github-pages/index.md b/content/en/host-and-deploy/host-on-github-pages/index.md index 47b3ce8076..2ead348eee 100644 --- a/content/en/host-and-deploy/host-on-github-pages/index.md +++ b/content/en/host-and-deploy/host-on-github-pages/index.md @@ -36,7 +36,7 @@ Step 1 ![screen capture](gh-pages-02.png) Step 2 -: In your site configuration, change the location of the image cache to the [`cacheDir`] as shown below: +: In your project configuration, change the location of the image cache to the [`cacheDir`] as shown below: {{< code-toggle file=hugo copy=true >}} [caches.images] diff --git a/content/en/host-and-deploy/host-on-gitlab-pages.md b/content/en/host-and-deploy/host-on-gitlab-pages.md index 56d5a200a0..441c0b11ff 100644 --- a/content/en/host-and-deploy/host-on-gitlab-pages.md +++ b/content/en/host-and-deploy/host-on-gitlab-pages.md @@ -15,7 +15,7 @@ aliases: [/hosting-and-deployment/hosting-on-gitlab/] ## BaseURL -The `baseURL` in your [site configuration](/configuration/) must reflect the full URL of your GitLab pages repository if you are using the default GitLab Pages URL (e.g., `https://.gitlab.io//`) and not a custom domain. +The `baseURL` in your [project configuration](/configuration/) must reflect the full URL of your GitLab pages repository if you are using the default GitLab Pages URL (e.g., `https://.gitlab.io//`) and not a custom domain. ## Configure GitLab CI/CD diff --git a/content/en/host-and-deploy/host-on-sourcehut-pages.md b/content/en/host-and-deploy/host-on-sourcehut-pages.md index 34d199efd7..75f3b45b5f 100644 --- a/content/en/host-and-deploy/host-on-sourcehut-pages.md +++ b/content/en/host-and-deploy/host-on-sourcehut-pages.md @@ -22,7 +22,7 @@ Any and all mentions of `` refer to your actual SourceHut username ## BaseURL -The [`baseURL`][] in your site configuration must reflect the full URL provided by SourceHut Pages if you are using the default address (e.g. `https://.srht.site/`). If you want to use another domain, check the [custom domain section][] of the official documentation. +The [`baseURL`][] in your project configuration must reflect the full URL provided by SourceHut Pages if you are using the default address (e.g. `https://.srht.site/`). If you want to use another domain, check the [custom domain section][] of the official documentation. [`baseURL`]: /configuration/all/#baseurl [custom domain section]: https://srht.site/custom-domains diff --git a/content/en/hugo-modules/use-modules.md b/content/en/hugo-modules/use-modules.md index ba9f2dffcd..eb15b13a75 100644 --- a/content/en/hugo-modules/use-modules.md +++ b/content/en/hugo-modules/use-modules.md @@ -32,7 +32,7 @@ This will generate a [`go.mod`][] file in the project root. > [!note] > The module name is a unique identifier rather than a hosting requirement. Using a name like `github.com/user/project` is a common convention but it does not mean you must use Git or host your code on GitHub. You can use any name you like if you do not plan to have others import your project as a module. For example, you could use a simple name such as `my-project` when you run the initialization command. -Then define one or more imports in your site configuration. This contrived example imports three modules, each containing custom shortcodes: +Then define one or more imports in your project configuration. This contrived example imports three modules, each containing custom shortcodes: {{< code-toggle file=hugo >}} [module] @@ -49,7 +49,7 @@ Import precedence is top-down. For example, if `shortcodes-a`, `shortcodes-b`, a > [!note] > If multiple modules contain data files or [translation tables](g) with identical paths, the data is deeply merged, following top-down precedence. -When you build your site, Hugo will: +When you build your project, Hugo will: 1. Download the modules 1. Cache them for future use @@ -140,7 +140,7 @@ For local module development, use a `replace` directive in `go.mod` pointing to replace github.com/user/module => /home/user/projects/module ``` -With `hugo serve`r running, this change will trigger a configuration reload and add the local directory to the watch list. Alternatively, configure replacements by setting the [`replacements`][] parameter in your site configuration. +With `hugo serve`r running, this change will trigger a configuration reload and add the local directory to the watch list. Alternatively, configure replacements by setting the [`replacements`][] parameter in your project configuration. ## Workspace diff --git a/content/en/methods/menu-entry/Children.md b/content/en/methods/menu-entry/Children.md index ecad415fa0..16cec71d96 100644 --- a/content/en/methods/menu-entry/Children.md +++ b/content/en/methods/menu-entry/Children.md @@ -11,7 +11,7 @@ params: Use the `Children` method when rendering a nested menu. -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [[menus.main]] diff --git a/content/en/methods/menu-entry/HasChildren.md b/content/en/methods/menu-entry/HasChildren.md index 03e6cb672f..59ef2e19e6 100644 --- a/content/en/methods/menu-entry/HasChildren.md +++ b/content/en/methods/menu-entry/HasChildren.md @@ -11,7 +11,7 @@ params: Use the `HasChildren` method when rendering a nested menu. -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [[menus.main]] diff --git a/content/en/methods/menu-entry/Name.md b/content/en/methods/menu-entry/Name.md index 706d0f8c84..a00601b2de 100644 --- a/content/en/methods/menu-entry/Name.md +++ b/content/en/methods/menu-entry/Name.md @@ -11,13 +11,7 @@ params: If you define the menu entry [automatically], the `Name` method returns the page's [`LinkTitle`], falling back to its [`Title`]. -If you define the menu entry [in front matter] or [in site configuration], the `Name` method returns the `name` property of the given menu entry. If the `name` is not defined, and the menu entry resolves to a page, the `Name` returns the page [`LinkTitle`], falling back to its [`Title`]. - -[`LinkTitle`]: /methods/page/linktitle/ -[`Title`]: /methods/page/title/ -[automatically]: /content-management/menus/#define-automatically -[in front matter]: /content-management/menus/#define-in-front-matter -[in site configuration]: /content-management/menus/#define-in-site-configuration +If you define the menu entry in [front matter] or in your [project configuration], the `Name` method returns the `name` property of the given menu entry. If the `name` is not defined, and the menu entry resolves to a page, the `Name` returns the page [`LinkTitle`], falling back to its [`Title`]. ```go-html-template
    @@ -26,3 +20,9 @@ If you define the menu entry [in front matter] or [in site configuration], the ` {{ end }}
``` + +[`LinkTitle`]: /methods/page/linktitle/ +[`Title`]: /methods/page/title/ +[automatically]: /content-management/menus/#define-automatically +[front matter]: /content-management/menus/#define-in-front-matter +[project configuration]: /content-management/menus/#define-in-project-configuration diff --git a/content/en/methods/menu-entry/PageRef.md b/content/en/methods/menu-entry/PageRef.md index 31db24de07..8d4e536566 100644 --- a/content/en/methods/menu-entry/PageRef.md +++ b/content/en/methods/menu-entry/PageRef.md @@ -15,7 +15,7 @@ params: ## Explanation -If you specify a `pageRef` property when [defining a menu entry] in your site configuration, Hugo looks for a matching page when rendering the entry. +If you specify a `pageRef` property when [defining a menu entry] in your project configuration, Hugo looks for a matching page when rendering the entry. If a matching page is found: @@ -100,10 +100,10 @@ Hugo renders this HTML: ``` -In the above note that Hugo populates the `href` attribute of the second `anchor` element with the `pageRef` property as defined in the site configuration because the template code falls back to the `PageRef` method. +In the above note that Hugo populates the `href` attribute of the second `anchor` element with the `pageRef` property as defined in your project configuration because the template code falls back to the `PageRef` method. [`HasMenuCurrent`]: /methods/page/hasmenucurrent/ [`IsMenuCurrent`]: /methods/page/ismenucurrent/ [`Page`]: /methods/menu-entry/page/ [`URL`]: /methods/menu-entry/url/ -[defining a menu entry]: /content-management/menus/#define-in-site-configuration +[defining a menu entry]: /content-management/menus/#define-in-project-configuration diff --git a/content/en/methods/menu-entry/Params.md b/content/en/methods/menu-entry/Params.md index 20c4f7fc73..1131781471 100644 --- a/content/en/methods/menu-entry/Params.md +++ b/content/en/methods/menu-entry/Params.md @@ -9,7 +9,7 @@ params: signatures: [MENUENTRY.Params] --- -When you define menu entries [in site configuration] or [in front matter], you can include a `params` key to attach additional information to the entry. For example: +When you define menu entries in your [project configuration] or in [front matter], you can include a `params` key to attach additional information to the entry. For example: {{< code-toggle file=hugo >}} [[menus.main]] @@ -57,5 +57,5 @@ Hugo renders: See the [menu templates] section for more information. [menu templates]: /templates/menu/#menu-entry-parameters -[in front matter]: /content-management/menus/#define-in-front-matter -[in site configuration]: /content-management/menus/ +[front matter]: /content-management/menus/#define-in-front-matter +[project configuration]: /content-management/menus/ diff --git a/content/en/methods/menu-entry/Weight.md b/content/en/methods/menu-entry/Weight.md index b96e2cc870..17fc3a43b4 100644 --- a/content/en/methods/menu-entry/Weight.md +++ b/content/en/methods/menu-entry/Weight.md @@ -11,12 +11,7 @@ params: If you define the menu entry [automatically], the `Weight` method returns the page's [`Weight`]. -If you define the menu entry [in front matter] or [in site configuration], the `Weight` method returns the `weight` property, falling back to the page's `Weight`. - -[`Weight`]: /methods/page/weight/ -[automatically]: /content-management/menus/#define-automatically -[in front matter]: /content-management/menus/#define-in-front-matter -[in site configuration]: /content-management/menus/#define-in-site-configuration +If you define the menu entry in [front matter] or in your [project configuration], the `Weight` method returns the `weight` property, falling back to the page's `Weight`. In this contrived example, we limit the number of menu entries based on weight: @@ -29,3 +24,8 @@ In this contrived example, we limit the number of menu entries based on weight: {{ end }} ``` + +[`Weight`]: /methods/page/weight/ +[automatically]: /content-management/menus/#define-automatically +[front matter]: /content-management/menus/#define-in-front-matter +[project configuration]: /content-management/menus/#define-in-project-configuration diff --git a/content/en/methods/output-format/Rel.md b/content/en/methods/output-format/Rel.md index 1dca4b10ab..4c3db9791b 100644 --- a/content/en/methods/output-format/Rel.md +++ b/content/en/methods/output-format/Rel.md @@ -1,6 +1,6 @@ --- title: Rel -description: Returns the rel value of the given output format, either the default or as defined in the site configuration. +description: Returns the rel value of the given output format, either the default or as defined in your project configuration. categories: [] keywords: [] params: diff --git a/content/en/methods/page/Aliases.md b/content/en/methods/page/Aliases.md index c5e0951e78..217af4e99b 100644 --- a/content/en/methods/page/Aliases.md +++ b/content/en/methods/page/Aliases.md @@ -52,7 +52,7 @@ Page-relative paths can also include directory traversal: ### Project configuration -To implement this, you must update your site configuration to: +To implement this, you must update your project configuration to: 1. Disable the generation of default HTML redirect files by setting `disableAliases` to `true`. 1. Define a [media type][] named `text/redirects` to handle the file format. diff --git a/content/en/methods/page/AllTranslations.md b/content/en/methods/page/AllTranslations.md index ed92cd4826..27a9f932a7 100644 --- a/content/en/methods/page/AllTranslations.md +++ b/content/en/methods/page/AllTranslations.md @@ -9,7 +9,7 @@ params: signatures: [PAGE.AllTranslations] --- -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' diff --git a/content/en/methods/page/Data.md b/content/en/methods/page/Data.md index 3874229014..3d4433a8eb 100644 --- a/content/en/methods/page/Data.md +++ b/content/en/methods/page/Data.md @@ -16,7 +16,7 @@ The `Data` method on a `Page` object returns a unique data object for each [page > > Themes that are not actively maintained may still use `.Data.Pages` in their templates. Although that syntax remains functional, use one of these methods instead: [`Pages`], [`RegularPages`], or [`RegularPagesRecursive`] -The examples that follow are based on this site configuration: +The examples that follow are based on this project configuration: {{< code-toggle file=hugo >}} [taxonomies] diff --git a/content/en/methods/page/Date.md b/content/en/methods/page/Date.md index 21bf034452..ffddcf047f 100644 --- a/content/en/methods/page/Date.md +++ b/content/en/methods/page/Date.md @@ -17,7 +17,7 @@ date = 2023-10-19T00:40:04-07:00 {{< /code-toggle >}} > [!note] -> The date field in front matter is often considered to be the creation date, You can change its meaning, and its effect on your site, in the site configuration. See [details]. +> The date field in front matter is often considered to be the creation date, You can change its meaning, and its effect on your project, in your project configuration. See [details]. The date is a [time.Time] value. Format and localize the value with the [`time.Format`] function, or use it with any of the [time methods]. diff --git a/content/en/methods/page/Draft.md b/content/en/methods/page/Draft.md index 482a370bf8..d814d85419 100644 --- a/content/en/methods/page/Draft.md +++ b/content/en/methods/page/Draft.md @@ -9,7 +9,7 @@ params: signatures: [PAGE.Draft] --- -By default, Hugo does not publish draft pages when you build your site. To include draft pages when you build your site, use the `--buildDrafts` command line flag. +By default, Hugo does not publish draft pages when you build your project. To include draft pages when you build your project, use the `--buildDrafts` command line flag. {{< code-toggle file=content/posts/post-1.md fm=true >}} title = 'Post 1' diff --git a/content/en/methods/page/Fragments.md b/content/en/methods/page/Fragments.md index 1b30ac9733..9df47f31c2 100644 --- a/content/en/methods/page/Fragments.md +++ b/content/en/methods/page/Fragments.md @@ -71,7 +71,7 @@ To inspect the data structure: (`template.HTML`) Returns a TOC as a nested list, either ordered or unordered, identical to the HTML returned by the [`TableOfContents`] method. This method take three arguments: the start level (`int`), the end level (`int`), and a boolean (`true` to return an ordered list, `false` to return an unordered list). -Use this method when you want to control the start level, end level, or list type independently from the table of contents settings in your site configuration. +Use this method when you want to control the start level, end level, or list type independently from the table of contents settings in your project configuration. ```go-html-template {{ $startLevel := 2 }} diff --git a/content/en/methods/page/GitInfo.md b/content/en/methods/page/GitInfo.md index 4c9ed96b98..ef2dffa4c8 100644 --- a/content/en/methods/page/GitInfo.md +++ b/content/en/methods/page/GitInfo.md @@ -18,7 +18,7 @@ The `GitInfo` method on a `Page` object returns an object with additional method Install Git, create a repository, and commit your project files. -You must also allow Hugo to access your repository. In your site configuration: +You must also allow Hugo to access your repository. In your project configuration: {{< code-toggle file=hugo >}} enableGitInfo = true @@ -149,7 +149,7 @@ To reverse the order: By default, when `enableGitInfo` is `true`, the `Lastmod` method on a `Page` object returns the Git AuthorDate of the last commit that included the file. -You can change this behavior in your [site configuration]. +You can change this behavior in your [project configuration]. ## Hosting considerations @@ -182,4 +182,4 @@ Vercel|Shallow|Yes [^1] [details]: /configuration/front-matter/#dates [gitmailmap]: https://git-scm.com/docs/gitmailmap -[site configuration]: /configuration/front-matter/ +[project configuration]: /configuration/front-matter/ diff --git a/content/en/methods/page/HasMenuCurrent.md b/content/en/methods/page/HasMenuCurrent.md index 2078821672..22bcc6483c 100644 --- a/content/en/methods/page/HasMenuCurrent.md +++ b/content/en/methods/page/HasMenuCurrent.md @@ -28,6 +28,6 @@ If the `Page` object associated with the menu entry is a section, this method al See [menu templates] for a complete example. > [!note] -> When using this method you must either define the menu entry in front matter, or specify a `pageRef` property when defining the menu entry in your site configuration. +> When using this method you must either define the menu entry in front matter, or specify a `pageRef` property when defining the menu entry in your project configuration. [menu templates]: /templates/menu/#example diff --git a/content/en/methods/page/IsMenuCurrent.md b/content/en/methods/page/IsMenuCurrent.md index 9bbacd018f..60b68428a6 100644 --- a/content/en/methods/page/IsMenuCurrent.md +++ b/content/en/methods/page/IsMenuCurrent.md @@ -26,6 +26,6 @@ aliases: [/functions/ismenucurrent] See [menu templates] for a complete example. > [!note] -> When using this method you must either define the menu entry in front matter, or specify a `pageRef` property when defining the menu entry in your site configuration. +> When using this method you must either define the menu entry in front matter, or specify a `pageRef` property when defining the menu entry in your project configuration. [menu templates]: /templates/menu/#example diff --git a/content/en/methods/page/IsTranslated.md b/content/en/methods/page/IsTranslated.md index 2cdf911ac7..6ce340ecbd 100644 --- a/content/en/methods/page/IsTranslated.md +++ b/content/en/methods/page/IsTranslated.md @@ -9,7 +9,7 @@ params: signatures: [PAGE.IsTranslated] --- -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' diff --git a/content/en/methods/page/Paginate.md b/content/en/methods/page/Paginate.md index 3378112406..452bf9daf8 100644 --- a/content/en/methods/page/Paginate.md +++ b/content/en/methods/page/Paginate.md @@ -11,7 +11,7 @@ params: Pagination is the process of splitting a list page into two or more pagers, where each pager contains a subset of the page collection and navigation links to other pagers. -By default, the number of elements on each pager is determined by your [site configuration]. The default is `10`. Override that value by providing a second argument, an integer, when calling the `Paginate` method. +By default, the number of elements on each pager is determined by your [project configuration]. The default is `10`. Override that value by providing a second argument, an integer, when calling the `Paginate` method. > [!note] > There is also a `Paginator` method on `Page` objects, but it can neither filter nor sort the page collection. @@ -42,6 +42,6 @@ In the example above, we: [home]: /templates/types/#home [section]: /templates/types/#section -[site configuration]: /configuration/pagination/ +[project configuration]: /configuration/pagination/ [taxonomy]: /templates/types/#taxonomy [term]: /templates/types/#term diff --git a/content/en/methods/page/Paginator.md b/content/en/methods/page/Paginator.md index 02b5d57196..059e55e2d6 100644 --- a/content/en/methods/page/Paginator.md +++ b/content/en/methods/page/Paginator.md @@ -11,7 +11,7 @@ params: Pagination is the process of splitting a list page into two or more pagers, where each pager contains a subset of the page collection and navigation links to other pagers. -The number of elements on each pager is determined by your [site configuration]. The default is `10`. +The number of elements on each pager is determined by your [project configuration]. The default is `10`. You can invoke pagination in [home], [section], [taxonomy], and [term] templates. Each of these receives a collection of regular pages in [context](g). When you invoke the `Paginator` method, it paginates the page collection received in context. @@ -34,7 +34,7 @@ In the example above, the embedded pagination template creates navigation links [home]: /templates/types/#home [section]: /templates/types/#section -[site configuration]: /configuration/pagination/ +[project configuration]: /configuration/pagination/ [taxonomy]: /templates/types/#taxonomy [term]: /templates/types/#term [`Paginate`]: /methods/page/paginate/ diff --git a/content/en/methods/page/Sitemap.md b/content/en/methods/page/Sitemap.md index 5dafb86b23..1d40f48b17 100644 --- a/content/en/methods/page/Sitemap.md +++ b/content/en/methods/page/Sitemap.md @@ -39,7 +39,7 @@ Access to the `Sitemap` method on a `Page` object is restricted to [sitemap temp ## Example -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [sitemap] diff --git a/content/en/methods/page/Sites.md b/content/en/methods/page/Sites.md index 6957bfcf04..98aeeab020 100644 --- a/content/en/methods/page/Sites.md +++ b/content/en/methods/page/Sites.md @@ -18,7 +18,7 @@ Use [`hugo.Sites`] instead. {{% include "/_common/functions/hugo/sites-collection.md" %}} -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' diff --git a/content/en/methods/page/TableOfContents.md b/content/en/methods/page/TableOfContents.md index f44d660aeb..d5ae216395 100644 --- a/content/en/methods/page/TableOfContents.md +++ b/content/en/methods/page/TableOfContents.md @@ -37,7 +37,7 @@ Produces this HTML: ``` -By default, the `TableOfContents` method returns an unordered list of level 2 and level 3 headings. You can adjust this in your site configuration: +By default, the `TableOfContents` method returns an unordered list of level 2 and level 3 headings. You can adjust this in your project configuration: {{< code-toggle file=hugo >}} [markup.tableOfContents] diff --git a/content/en/methods/page/Title.md b/content/en/methods/page/Title.md index 2201266a73..5135c5ac4e 100644 --- a/content/en/methods/page/Title.md +++ b/content/en/methods/page/Title.md @@ -28,14 +28,14 @@ section|section name (capitalized and pluralized) taxonomy|taxonomy name (capitalized and pluralized) term|term name (capitalized and pluralized) -You can disable automatic capitalization and pluralization in your site configuration: +You can disable automatic capitalization and pluralization in your project configuration: {{< code-toggle file=hugo >}} capitalizeListTitles = false pluralizeListTitles = false {{< /code-toggle >}} -You can change the capitalization style in your site configuration to one of `ap`, `chicago`, `go`, `firstupper`, or `none`. For example: +You can change the capitalization style in your project configuration to one of `ap`, `chicago`, `go`, `firstupper`, or `none`. For example: {{< code-toggle file=hugo >}} titleCaseStyle = "firstupper" diff --git a/content/en/methods/page/TranslationKey.md b/content/en/methods/page/TranslationKey.md index 1e930687e9..2f6b8f3081 100644 --- a/content/en/methods/page/TranslationKey.md +++ b/content/en/methods/page/TranslationKey.md @@ -11,7 +11,7 @@ params: The translation key creates a relationship between all translations of a given page. The translation key is derived from the file path, or from the `translationKey` parameter if defined in front matter. -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' diff --git a/content/en/methods/page/Translations.md b/content/en/methods/page/Translations.md index c342a86186..58f9024f72 100644 --- a/content/en/methods/page/Translations.md +++ b/content/en/methods/page/Translations.md @@ -9,7 +9,7 @@ params: signatures: [PAGE.Translations] --- -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'en' diff --git a/content/en/methods/pager/PagerSize.md b/content/en/methods/pager/PagerSize.md index b2397a3e84..13aa6c1cd7 100644 --- a/content/en/methods/pager/PagerSize.md +++ b/content/en/methods/pager/PagerSize.md @@ -11,10 +11,10 @@ params: {{< new-in 0.128.0 />}} -The number of pages per pager is determined by the optional second argument passed to the [`Paginate`] method, falling back to the `pagerSize` as defined in your [site configuration]. +The number of pages per pager is determined by the optional second argument passed to the [`Paginate`] method, falling back to the `pagerSize` as defined in your [project configuration]. [`Paginate`]: /methods/page/paginate/ -[site configuration]: /templates/pagination/#configuration +[project configuration]: /templates/pagination/#configuration ```go-html-template {{ $pages := where site.RegularPages "Type" "posts" }} diff --git a/content/en/methods/pages/ByDate.md b/content/en/methods/pages/ByDate.md index 18f1b985ee..5d1e339a02 100644 --- a/content/en/methods/pages/ByDate.md +++ b/content/en/methods/pages/ByDate.md @@ -9,9 +9,9 @@ params: signatures: [PAGES.ByDate] --- -When sorting by date, the value is determined by your [site configuration], defaulting to the `date` field in front matter. +When sorting by date, the value is determined by your [project configuration], defaulting to the `date` field in front matter. -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates ```go-html-template {{ range .Pages.ByDate }} diff --git a/content/en/methods/pages/ByExpiryDate.md b/content/en/methods/pages/ByExpiryDate.md index 703988c4e3..4f34c6e03b 100644 --- a/content/en/methods/pages/ByExpiryDate.md +++ b/content/en/methods/pages/ByExpiryDate.md @@ -9,9 +9,9 @@ params: signatures: [PAGES.ByExpiryDate] --- -When sorting by expiration date, the value is determined by your [site configuration], defaulting to the `expiryDate` field in front matter. +When sorting by expiration date, the value is determined by your [project configuration], defaulting to the `expiryDate` field in front matter. -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates ```go-html-template {{ range .Pages.ByExpiryDate }} diff --git a/content/en/methods/pages/ByLastmod.md b/content/en/methods/pages/ByLastmod.md index 3c03d2a6e2..7fc865e0a6 100644 --- a/content/en/methods/pages/ByLastmod.md +++ b/content/en/methods/pages/ByLastmod.md @@ -9,9 +9,9 @@ params: signatures: [PAGES.ByLastmod] --- -When sorting by last modification date, the value is determined by your [site configuration], defaulting to the `lastmod` field in front matter. +When sorting by last modification date, the value is determined by your [project configuration], defaulting to the `lastmod` field in front matter. -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates ```go-html-template {{ range .Pages.ByLastmod }} diff --git a/content/en/methods/pages/ByParam.md b/content/en/methods/pages/ByParam.md index 9544122a6b..fcc9b287fa 100644 --- a/content/en/methods/pages/ByParam.md +++ b/content/en/methods/pages/ByParam.md @@ -9,7 +9,7 @@ params: signatures: [PAGES.ByParam PARAM] --- -If the given parameter is not present in front matter, Hugo will use the matching parameter in your site configuration if present. +If the given parameter is not present in front matter, Hugo will use the matching parameter in your project configuration if present. ```go-html-template {{ range .Pages.ByParam "author" }} diff --git a/content/en/methods/pages/ByPublishDate.md b/content/en/methods/pages/ByPublishDate.md index 3dde6fd954..76d2b2b586 100644 --- a/content/en/methods/pages/ByPublishDate.md +++ b/content/en/methods/pages/ByPublishDate.md @@ -9,9 +9,9 @@ params: signatures: [PAGES.ByPublishDate] --- -When sorting by publish date, the value is determined by your [site configuration], defaulting to the `publishDate` field in front matter. +When sorting by publish date, the value is determined by your [project configuration], defaulting to the `publishDate` field in front matter. -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates ```go-html-template {{ range .Pages.ByPublishDate }} diff --git a/content/en/methods/pages/GroupByDate.md b/content/en/methods/pages/GroupByDate.md index 7ef4843a4e..19f7918865 100644 --- a/content/en/methods/pages/GroupByDate.md +++ b/content/en/methods/pages/GroupByDate.md @@ -9,13 +9,13 @@ params: signatures: ['PAGES.GroupByDate LAYOUT [SORT]'] --- -When grouping by date, the value is determined by your [site configuration], defaulting to the `date` field in front matter. +When grouping by date, the value is determined by your [project configuration], defaulting to the `date` field in front matter. The [layout string] has the same format as the layout string for the [`time.Format`] function. The resulting group key is [localized](g) for language and region. [`time.Format`]: /functions/time/format/ [layout string]: #layout-string -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates {{% include "/_common/methods/pages/group-sort-order.md" %}} diff --git a/content/en/methods/pages/GroupByExpiryDate.md b/content/en/methods/pages/GroupByExpiryDate.md index d209e6c2b7..7fe0282c2c 100644 --- a/content/en/methods/pages/GroupByExpiryDate.md +++ b/content/en/methods/pages/GroupByExpiryDate.md @@ -9,13 +9,13 @@ params: signatures: ['PAGES.GroupByExpiryDate LAYOUT [SORT]'] --- -When grouping by expiration date, the value is determined by your [site configuration], defaulting to the `expiryDate` field in front matter. +When grouping by expiration date, the value is determined by your [project configuration], defaulting to the `expiryDate` field in front matter. The [layout string] has the same format as the layout string for the [`time.Format`] function. The resulting group key is [localized](g) for language and region. [`time.Format`]: /functions/time/format/ [layout string]: #layout-string -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates {{% include "/_common/methods/pages/group-sort-order.md" %}} diff --git a/content/en/methods/pages/GroupByLastmod.md b/content/en/methods/pages/GroupByLastmod.md index 8729cd3c96..45da5af31a 100644 --- a/content/en/methods/pages/GroupByLastmod.md +++ b/content/en/methods/pages/GroupByLastmod.md @@ -9,13 +9,13 @@ params: signatures: ['PAGES.GroupByLastmod LAYOUT [SORT]'] --- -When grouping by last modification date, the value is determined by your [site configuration], defaulting to the `lastmod` field in front matter. +When grouping by last modification date, the value is determined by your [project configuration], defaulting to the `lastmod` field in front matter. The [layout string] has the same format as the layout string for the [`time.Format`] function. The resulting group key is [localized](g) for language and region. [`time.Format`]: /functions/time/format/ [layout string]: #layout-string -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates {{% include "/_common/methods/pages/group-sort-order.md" %}} diff --git a/content/en/methods/pages/GroupByPublishDate.md b/content/en/methods/pages/GroupByPublishDate.md index 50e12f0850..629a8480a7 100644 --- a/content/en/methods/pages/GroupByPublishDate.md +++ b/content/en/methods/pages/GroupByPublishDate.md @@ -9,13 +9,13 @@ params: signatures: ['PAGES.GroupByPublishDate LAYOUT [SORT]'] --- -When grouping by publish date, the value is determined by your [site configuration], defaulting to the `publishDate` field in front matter. +When grouping by publish date, the value is determined by your [project configuration], defaulting to the `publishDate` field in front matter. The [layout string] has the same format as the layout string for the [`time.Format`] function. The resulting group key is [localized](g) for language and region. [`time.Format`]: /functions/time/format/ [layout string]: #layout-string -[site configuration]: /configuration/front-matter/#dates +[project configuration]: /configuration/front-matter/#dates {{% include "/_common/methods/pages/group-sort-order.md" %}} diff --git a/content/en/methods/resource/Exif.md b/content/en/methods/resource/Exif.md index 4df1eef5ba..e1cd2ab598 100644 --- a/content/en/methods/resource/Exif.md +++ b/content/en/methods/resource/Exif.md @@ -34,7 +34,7 @@ To extract [Exif][Exif_Definition], [IPTC][IPTC_Definition], and [XMP][XMP_Defin ### Tags -(`meta.Tags`) Returns a collection of available Exif fields for this image. Availability is determined by the [`includeFields`][] and [`excludeFields`][] settings in your site configuration. +(`meta.Tags`) Returns a collection of available Exif fields for this image. Availability is determined by the [`includeFields`][] and [`excludeFields`][] settings in your project configuration. ## Examples diff --git a/content/en/methods/resource/Meta.md b/content/en/methods/resource/Meta.md index a1c8a9010b..b02e99862a 100644 --- a/content/en/methods/resource/Meta.md +++ b/content/en/methods/resource/Meta.md @@ -55,15 +55,15 @@ Value|Description ### Exif -(`meta.Tags`) Returns a collection of available Exif fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your site configuration. +(`meta.Tags`) Returns a collection of available Exif fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your project configuration. ### IPTC -(`meta.Tags`) Returns a collection of available IPTC fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your site configuration. +(`meta.Tags`) Returns a collection of available IPTC fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your project configuration. ### XMP -(`meta.Tags`) Returns a collection of available XMP fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your site configuration. +(`meta.Tags`) Returns a collection of available XMP fields for this image. Availability is determined by the [`sources`][] setting and specific fields are managed via the [`fields`][] setting, both of which are managed in your project configuration. ## Examples diff --git a/content/en/methods/site/BaseURL.md b/content/en/methods/site/BaseURL.md index 5af0d3f018..7b1b5e8704 100644 --- a/content/en/methods/site/BaseURL.md +++ b/content/en/methods/site/BaseURL.md @@ -1,6 +1,6 @@ --- title: BaseURL -description: Returns the base URL as defined in the site configuration. +description: Returns the base URL as defined in your project configuration. categories: [] keywords: [] params: diff --git a/content/en/methods/site/BuildDrafts.md b/content/en/methods/site/BuildDrafts.md index ac6c9640f5..7b5019ffe1 100644 --- a/content/en/methods/site/BuildDrafts.md +++ b/content/en/methods/site/BuildDrafts.md @@ -20,7 +20,7 @@ By default, draft pages are not published when building a site. You can change t hugo build --buildDrafts ``` -Or by setting `buildDrafts` to `true` in your site configuration: +Or by setting `buildDrafts` to `true` in your project configuration: {{< code-toggle file=hugo >}} buildDrafts = true diff --git a/content/en/methods/site/Config.md b/content/en/methods/site/Config.md index d1b4d1f421..9cc8856507 100644 --- a/content/en/methods/site/Config.md +++ b/content/en/methods/site/Config.md @@ -1,6 +1,6 @@ --- title: Config -description: Returns a subset of the site configuration. +description: Returns a subset of your project configuration. categories: [] keywords: [] params: @@ -9,7 +9,7 @@ params: signatures: [SITE.Config] --- -The `Config` method on a `Site` object provides access to a subset of the site configuration, specifically the `services` and `privacy` keys. +The `Config` method on a `Site` object provides access to a subset of your project configuration, specifically the `services` and `privacy` keys. ## Services diff --git a/content/en/methods/site/Copyright.md b/content/en/methods/site/Copyright.md index e42fa08892..e73ff66bce 100644 --- a/content/en/methods/site/Copyright.md +++ b/content/en/methods/site/Copyright.md @@ -1,6 +1,6 @@ --- title: Copyright -description: Returns the copyright notice as defined in the site configuration. +description: Returns the copyright notice as defined in your project configuration. categories: [] keywords: [] params: diff --git a/content/en/methods/site/LanguagePrefix.md b/content/en/methods/site/LanguagePrefix.md index 81a5e8607f..7b92c59505 100644 --- a/content/en/methods/site/LanguagePrefix.md +++ b/content/en/methods/site/LanguagePrefix.md @@ -9,7 +9,7 @@ params: signatures: [SITE.LanguagePrefix] --- -Consider this site configuration: +Consider this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' diff --git a/content/en/methods/site/Languages.md b/content/en/methods/site/Languages.md index 657f29be6d..69277f3293 100644 --- a/content/en/methods/site/Languages.md +++ b/content/en/methods/site/Languages.md @@ -14,7 +14,7 @@ expiryDate: '2028-02-18' # deprecated 2026-02-18 in v0.156.0 See [details](https://discourse.gohugo.io/t/56732). {{< /deprecated-in >}} -The `Languages` method on a `Site` object returns a collection of language objects for all sites, ordered by language weight. Each language object points to its language definition in the site configuration. +The `Languages` method on a `Site` object returns a collection of language objects for all sites, ordered by language weight. Each language object points to its language definition in your project configuration. To inspect the data structure: @@ -22,7 +22,7 @@ To inspect the data structure: 
{{ debug.Dump .Site.Languages }}
``` -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' diff --git a/content/en/methods/site/MainSections.md b/content/en/methods/site/MainSections.md index 7f08b2ff51..0df8de649e 100644 --- a/content/en/methods/site/MainSections.md +++ b/content/en/methods/site/MainSections.md @@ -1,6 +1,6 @@ --- title: MainSections -description: Returns a slice of the main section names as defined in the site configuration, falling back to the top-level section with the most pages. +description: Returns a slice of the main section names as defined in your project configuration, falling back to the top-level section with the most pages. categories: [] keywords: [] params: @@ -21,7 +21,7 @@ Template: {{ .Site.MainSections }} → [books films] ``` -If `mainSections` is not defined in the site configuration, this method returns a slice with one element---the top-level section with the most pages. +If `mainSections` is not defined in your project configuration, this method returns a slice with one element---the top-level section with the most pages. With this content structure, the "films" section has the most pages: @@ -43,7 +43,7 @@ Template: {{ .Site.MainSections }} → [films] ``` -When creating a theme, instead of hardcoding section names when listing the most relevant pages on the front page, instruct site authors to set `mainSections` in their site configuration. +When creating a theme, instead of hardcoding section names when listing the most relevant pages on the front page, instruct users to set `mainSections` in their project configuration. Then your _home_ template can do something like this: diff --git a/content/en/methods/site/Param.md b/content/en/methods/site/Param.md index 929e30e987..b2ec5d9bbb 100644 --- a/content/en/methods/site/Param.md +++ b/content/en/methods/site/Param.md @@ -9,7 +9,7 @@ params: signatures: [SITE.Param KEY] --- -The `Param` method on a `Site` object is a convenience method to return the value of a user-defined parameter in the site configuration. +The `Param` method on a `Site` object is a convenience method to return the value of a user-defined parameter in your project configuration. {{< code-toggle file=hugo >}} [params] diff --git a/content/en/methods/site/Params.md b/content/en/methods/site/Params.md index 8467be41de..62bc8f1f5c 100644 --- a/content/en/methods/site/Params.md +++ b/content/en/methods/site/Params.md @@ -1,6 +1,6 @@ --- title: Params -description: Returns a map of custom parameters as defined in the site configuration. +description: Returns a map of custom parameters as defined in your project configuration. categories: [] keywords: [] params: @@ -9,7 +9,7 @@ params: signatures: [SITE.Params] --- -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [params] diff --git a/content/en/methods/site/Role.md b/content/en/methods/site/Role.md index 4e44322fdb..b8aee5f4a6 100644 --- a/content/en/methods/site/Role.md +++ b/content/en/methods/site/Role.md @@ -11,7 +11,7 @@ params: {{< new-in 0.153.0 />}} -The `Role` method on a `Site` object returns the `Role` object for the given site, derived from the role definition in your site configuration. +The `Role` method on a `Site` object returns the `Role` object for the given site, derived from the role definition in your project configuration. ## Methods @@ -25,7 +25,7 @@ The `Role` method on a `Site` object returns the `Role` object for the given sit ### Name -(`string`) Returns the role name. This is the lowercased key from your site configuration. +(`string`) Returns the role name. This is the lowercased key from your project configuration. ```go-html-template {{ .Site.Role.Name }} → guest diff --git a/content/en/methods/site/Sites.md b/content/en/methods/site/Sites.md index baea581e02..7a06e232fc 100644 --- a/content/en/methods/site/Sites.md +++ b/content/en/methods/site/Sites.md @@ -18,7 +18,7 @@ Use [`hugo.Sites`] instead. {{% include "/_common/functions/hugo/sites-collection.md" %}} -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} defaultContentLanguage = 'de' diff --git a/content/en/methods/site/Taxonomies.md b/content/en/methods/site/Taxonomies.md index ab28aff1db..4417c9ef73 100644 --- a/content/en/methods/site/Taxonomies.md +++ b/content/en/methods/site/Taxonomies.md @@ -30,7 +30,7 @@ taxonomy b: For example, on a book review site you might create two taxonomies; one for genres and another for authors. -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} [taxonomies] diff --git a/content/en/methods/site/Title.md b/content/en/methods/site/Title.md index 1b899a3429..ad8a48c3cb 100644 --- a/content/en/methods/site/Title.md +++ b/content/en/methods/site/Title.md @@ -1,6 +1,6 @@ --- title: Title -description: Returns the title as defined in the site configuration. +description: Returns the title as defined in your project configuration. categories: [] keywords: [] params: diff --git a/content/en/methods/site/Version.md b/content/en/methods/site/Version.md index 15189165a0..d424d4666e 100644 --- a/content/en/methods/site/Version.md +++ b/content/en/methods/site/Version.md @@ -11,7 +11,7 @@ params: {{< new-in 0.153.0 />}} -The `Version` method on a `Site` object returns the `Version` object for the given site, derived from the version definition in your site configuration. +The `Version` method on a `Site` object returns the `Version` object for the given site, derived from the version definition in your project configuration. ## Methods @@ -25,7 +25,7 @@ The `Version` method on a `Site` object returns the `Version` object for the giv ### Name -(`string`) Returns the version name. This is the lowercased key from your site configuration. +(`string`) Returns the version name. This is the lowercased key from your project configuration. ```go-html-template {{ .Site.Version.Name }} → v1.0.0 diff --git a/content/en/quick-reference/glossary/canonical-output-format.md b/content/en/quick-reference/glossary/canonical-output-format.md index 88842a11f6..d360083ba9 100644 --- a/content/en/quick-reference/glossary/canonical-output-format.md +++ b/content/en/quick-reference/glossary/canonical-output-format.md @@ -2,13 +2,13 @@ title: canonical output format --- -The _canonical output format_ is the [_output format_](g) for the current page where the format's [`rel`][] property is set to `canonical` in your site configuration, if such a format exists. If there is only one _output format_ for the current page, that is the _canonical output format_, regardless of whether the format's `rel` property is set to `canonical`. +The _canonical output format_ is the [_output format_](g) for the current page where the format's [`rel`][] property is set to `canonical` in your project configuration, if such a format exists. If there is only one _output format_ for the current page, that is the _canonical output format_, regardless of whether the format's `rel` property is set to `canonical`. By default, `html` is the only predefined _output format_ with this setting; the `rel` property for all others is set to `alternate`. If two or more _output formats_ for the current page have their `rel` property set to `canonical`, the _canonical output format_ is the first one specified in: - The [`outputs`][outputs_front_matter] front matter field of the current page, or - - The [`outputs`][outputs_site_config] section of your site configuration for the current [_page kind_](g). + - The [`outputs`][outputs_project_config] section of your project configuration for the current [_page kind_](g). [`rel`]: /configuration/output-formats/#rel [outputs_front_matter]: /configuration/outputs/#outputs-per-page - [outputs_site_config]: /configuration/outputs/#outputs-per-page-kind + [outputs_project_config]: /configuration/outputs/#outputs-per-page-kind diff --git a/content/en/quick-reference/glossary/glob-slice.md b/content/en/quick-reference/glossary/glob-slice.md index faaa645815..df37718b1e 100644 --- a/content/en/quick-reference/glossary/glob-slice.md +++ b/content/en/quick-reference/glossary/glob-slice.md @@ -4,7 +4,7 @@ title: glob slice A _glob slice_ is a [_slice_](g) of [_glob patterns_](g). Within the _slice_, a _glob_ can be negated by prefixing it with an exclamation mark (`!`) and one space. Matches in negated patterns short-circuit the evaluation of the rest of the _slice_, and are useful for early coarse grained exclusions. - The following example illustrates how to use _glob slices_ to define a [_sites matrix_](g) in your site configuration: + The following example illustrates how to use _glob slices_ to define a [_sites matrix_](g) in your project configuration: ```toml [sites.matrix] diff --git a/content/en/quick-reference/glossary/regular-expression.md b/content/en/quick-reference/glossary/regular-expression.md index 222f289d94..82f8d98f54 100644 --- a/content/en/quick-reference/glossary/regular-expression.md +++ b/content/en/quick-reference/glossary/regular-expression.md @@ -3,6 +3,6 @@ title: regular expression reference: --- -A _regular expression_, also known as a _regex_, is a sequence of characters that defines a search pattern. Use the [RE2 syntax] when defining regular expressions in your templates or site configuration. +A _regular expression_, also known as a _regex_, is a sequence of characters that defines a search pattern. Use the [RE2 syntax] when defining regular expressions in your templates or in your project configuration. [RE2 syntax]: https://github.com/google/re2/wiki/syntax diff --git a/content/en/quick-reference/syntax-highlighting-styles.md b/content/en/quick-reference/syntax-highlighting-styles.md index 76aa77bf46..3ba6fd833b 100644 --- a/content/en/quick-reference/syntax-highlighting-styles.md +++ b/content/en/quick-reference/syntax-highlighting-styles.md @@ -15,7 +15,7 @@ Hugo provides several methods to add syntax highlighting to code examples: Regardless of method, use any of the syntax highlighting styles below. -Set the default syntax highlighting style in your site configuration: +Set the default syntax highlighting style in your project configuration: {{< code-toggle file=hugo >}} [markup.highlight] diff --git a/content/en/render-hooks/images.md b/content/en/render-hooks/images.md index e5f631cdcc..c89ce17460 100755 --- a/content/en/render-hooks/images.md +++ b/content/en/render-hooks/images.md @@ -89,7 +89,7 @@ To render standalone images within `figure` elements: {{- end -}} ``` -Note that the above requires the following site configuration: +Note that the above requires the following project configuration: {{< code-toggle file=hugo >}} [markup.goldmark.parser] @@ -98,7 +98,7 @@ wrapStandAloneImageWithinParagraph = false ## Embedded -Hugo includes an [embedded image render hook] to resolve Markdown image destinations. You can adjust its behavior in your site configuration. This is the default setting: +Hugo includes an [embedded image render hook] to resolve Markdown image destinations. You can adjust its behavior in your project configuration. This is the default setting: {{< code-toggle file=hugo >}} [markup.goldmark.renderHooks.image] @@ -111,7 +111,7 @@ You can also configure Hugo to `always` use the embedded image render hook, use The embedded image render hook resolves internal Markdown destinations by looking for a matching [page resource](g), falling back to a matching [global resource](g). Remote destinations are passed through, and the render hook will not throw an error or warning if unable to resolve a destination. -You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your site configuration: +You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your project configuration: {{< code-toggle file=hugo >}} [[module.mounts]] diff --git a/content/en/render-hooks/links.md b/content/en/render-hooks/links.md index d358691605..ee765c14bb 100755 --- a/content/en/render-hooks/links.md +++ b/content/en/render-hooks/links.md @@ -71,7 +71,7 @@ To include a `rel` attribute set to `external` for external links: ## Embedded -Hugo includes an [embedded link render hook] to resolve Markdown link destinations. You can adjust its behavior in your site configuration. This is the default setting: +Hugo includes an [embedded link render hook] to resolve Markdown link destinations. You can adjust its behavior in your project configuration. This is the default setting: {{< code-toggle file=hugo >}} [markup.goldmark.renderHooks.link] @@ -84,7 +84,7 @@ You can also configure Hugo to `always` use the embedded link render hook, use i The embedded link render hook resolves internal Markdown destinations by looking for a matching page, falling back to a matching [page resource](g), then falling back to a matching [global resource](g). Remote destinations are passed through, and the render hook will not throw an error or warning if unable to resolve a destination. -You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your site configuration: +You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your project configuration: {{< code-toggle file=hugo >}} [[module.mounts]] diff --git a/content/en/render-hooks/passthrough.md b/content/en/render-hooks/passthrough.md index 76643718fa..7aada5713e 100755 --- a/content/en/render-hooks/passthrough.md +++ b/content/en/render-hooks/passthrough.md @@ -27,7 +27,7 @@ passthrough element with opening and closing block delimiters. This is an \(inline\) passthrough element with opening and closing inline delimiters. ``` -Update your site configuration to enable the Passthrough extension and define opening and closing delimiters for each passthrough element type, either `block` or `inline`. For example: +Update your project configuration to enable the Passthrough extension and define opening and closing delimiters for each passthrough element type, either `block` or `inline`. For example: {{< code-toggle file=hugo >}} [markup.goldmark.extensions.passthrough] diff --git a/content/en/shortcodes/figure.md b/content/en/shortcodes/figure.md index 24d85064b4..42438f7ad3 100755 --- a/content/en/shortcodes/figure.md +++ b/content/en/shortcodes/figure.md @@ -94,7 +94,7 @@ attrlink The `figure` shortcode resolves internal Markdown destinations by looking for a matching [page resource](g), falling back to a matching [global resource](g). Remote destinations are passed through, and the render hook will not throw an error or warning if unable to resolve a destination. -You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your site configuration: +You must place global resources in the `assets` directory. If you have placed your resources in the `static` directory, and you are unable or unwilling to move them, you must mount the `static` directory to the `assets` directory by including both of these entries in your project configuration: {{< code-toggle file=hugo >}} [[module.mounts]] diff --git a/content/en/shortcodes/highlight.md b/content/en/shortcodes/highlight.md index c349e97be4..d427da7cc4 100755 --- a/content/en/shortcodes/highlight.md +++ b/content/en/shortcodes/highlight.md @@ -33,7 +33,7 @@ LANG : (`string`) The language of the code to highlight. Choose from one of the [supported languages]. This value is case-insensitive. OPTIONS -: (`string`) Zero or more space-separated key-value pairs wrapped in quotation marks. Set default values for each option in your [site configuration]. The key names are case-insensitive. +: (`string`) Zero or more space-separated key-value pairs wrapped in quotation marks. Set default values for each option in your [project configuration]. The key names are case-insensitive. ## Example @@ -94,7 +94,7 @@ This is some {{< hl >}}fmt.Println("inline"){{< /hl >}} code. ## Options -Pass the options when calling the shortcode. You can set their default values in your [site configuration]. +Pass the options when calling the shortcode. You can set their default values in your [project configuration]. {{% include "_common/syntax-highlighting-options.md" %}} @@ -102,6 +102,6 @@ Pass the options when calling the shortcode. You can set their default values in [Chroma]: https://github.com/alecthomas/chroma [content format]: /content-management/formats/ [highlighting styles]: /quick-reference/syntax-highlighting-styles/ -[site configuration]: /configuration/markup/#highlight +[project configuration]: /configuration/markup/#highlight [source code]: <{{% eturl highlight %}}> [supported languages]: /content-management/syntax-highlighting/#languages diff --git a/content/en/shortcodes/instagram.md b/content/en/shortcodes/instagram.md index 9f8b4fd264..f3223e7428 100755 --- a/content/en/shortcodes/instagram.md +++ b/content/en/shortcodes/instagram.md @@ -29,7 +29,7 @@ Huge renders this to: ## Privacy -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.instagram />}} diff --git a/content/en/shortcodes/param.md b/content/en/shortcodes/param.md index 967d128469..51310a2a10 100755 --- a/content/en/shortcodes/param.md +++ b/content/en/shortcodes/param.md @@ -1,7 +1,7 @@ --- title: Param shortcode linkTitle: Param -description: Insert a parameter from front matter or site configuration into your content using the param shortcode. +description: Insert a parameter from front matter or your project configuration into your content using the param shortcode. categories: [] keywords: [] --- diff --git a/content/en/shortcodes/vimeo.md b/content/en/shortcodes/vimeo.md index b094200181..d7ca7ee6cc 100755 --- a/content/en/shortcodes/vimeo.md +++ b/content/en/shortcodes/vimeo.md @@ -54,7 +54,7 @@ Here's an example using some of the available arguments: ## Privacy -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.vimeo />}} diff --git a/content/en/shortcodes/x.md b/content/en/shortcodes/x.md index 967a526a8b..1ca87949a6 100755 --- a/content/en/shortcodes/x.md +++ b/content/en/shortcodes/x.md @@ -31,7 +31,7 @@ Rendered: ## Privacy -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.x />}} @@ -46,7 +46,7 @@ simple The source code for the simple version of the shortcode is available [in this file]. -If you enable simple mode you may want to disable the hardcoded inline styles by setting `disableInlineCSS` to `true` in your site configuration. The default value for this setting is `false`. +If you enable simple mode you may want to disable the hardcoded inline styles by setting `disableInlineCSS` to `true` in your project configuration. The default value for this setting is `false`. {{< code-toggle config=services.x />}} diff --git a/content/en/shortcodes/youtube.md b/content/en/shortcodes/youtube.md index 1e72ee2840..c76c5f3083 100755 --- a/content/en/shortcodes/youtube.md +++ b/content/en/shortcodes/youtube.md @@ -70,7 +70,7 @@ Here's an example using some of the available arguments: ## Privacy -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.youTube />}} diff --git a/content/en/templates/embedded.md b/content/en/templates/embedded.md index 1edef4f303..d8de3061a9 100644 --- a/content/en/templates/embedded.md +++ b/content/en/templates/embedded.md @@ -47,7 +47,7 @@ You can also set the following in the front matter for a given piece of content: ### Privacy {#privacy-disqus} -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.disqus />}} @@ -82,7 +82,7 @@ To use this value in your own template, access the configured ID with `{{ site.C ### Privacy {#privacy-google-analytics} -Adjust the relevant privacy settings in your site configuration. +Adjust the relevant privacy settings in your project configuration. {{< code-toggle config=privacy.googleAnalytics />}} @@ -195,11 +195,11 @@ description = "Text about this post" images = ["post-cover.png"] {{}} -If [page bundles](/content-management/page-bundles/) are used and the `images` array is empty or undefined, images with file names matching `*feature*`, `*cover*`, or `*thumbnail*` are used for image metadata. If no image resources with those names are found, the images defined in the [site configuration](/configuration/) are used instead. If no images are found at all, then an image-less Twitter `summary` card is used instead of `summary_large_image`. +If [page bundles](/content-management/page-bundles/) are used and the `images` array is empty or undefined, images with file names matching `*feature*`, `*cover*`, or `*thumbnail*` are used for image metadata. If no image resources with those names are found, the images defined in your [project configuration](/configuration/) are used instead. If no images are found at all, then an image-less Twitter `summary` card is used instead of `summary_large_image`. Hugo uses the page title and description for the card's title and description fields. The page summary is used if no description is given. -Set the value of `twitter:site` in your site configuration: +Set the value of `twitter:site` in your project configuration: {{< code-toggle file=hugo >}} [params.social] diff --git a/content/en/templates/introduction.md b/content/en/templates/introduction.md index 57a1ac1b71..f8f4bff236 100644 --- a/content/en/templates/introduction.md +++ b/content/en/templates/introduction.md @@ -311,7 +311,7 @@ Object|Method|Description `Page`|[`Params`](methods/page/params/)|Returns a map of custom parameters as defined in the front matter of the given page. `Page`|[`Title`](methods/page/title/)|Returns the title of the given page. `Site`|[`Data`](methods/site/data/)|Returns a data structure composed from the files in the `data` directory. -`Site`|[`Params`](methods/site/params/)|Returns a map of custom parameters as defined in the site configuration. +`Site`|[`Params`](methods/site/params/)|Returns a map of custom parameters as defined in your project configuration. `Site`|[`Title`](methods/site/title/)|Returns the title as defined in the site configuration. Chain the method to its object with a dot (`.`) as shown below, remembering that the leading dot represents the [current context]. @@ -491,7 +491,7 @@ To test multiple conditions: See documentation for the [`Params`](/methods/site/params/) method on a `Site` object. -With this site configuration: +With this project configuration: {{< code-toggle file=hugo >}} title = 'ABC Widgets' diff --git a/content/en/templates/menu.md b/content/en/templates/menu.md index aa0e7c6738..976e9f8321 100644 --- a/content/en/templates/menu.md +++ b/content/en/templates/menu.md @@ -13,9 +13,9 @@ After [defining menu entries], use [menu methods] to render a menu. Three factors determine how to render a menu: -1. The method used to define the menu entries: [automatic], [in front matter], or [in site configuration] +1. The method used to define the menu entries: [automatic], in [front matter], or in your [project configuration] 1. The menu structure: flat or nested -1. The method used to [localize the menu entries]: site configuration or translation tables +1. The method used to [localize the menu entries]: project configuration or translation tables The example below handles every combination. @@ -96,9 +96,9 @@ This simplistic example renders a page parameter named `version` next to each en ## Menu entry parameters -When you define menu entries [in site configuration] or [in front matter], you can include a `params` key as shown in these examples: +When you define menu entries in your [project configuration] or in [front matter], you can include a `params` key as shown in these examples: -- [Menu entry defined in site configuration] +- [Menu entry defined in your project configuration] - [Menu entry defined in front matter] This simplistic example renders a `class` attribute for each anchor element. Code defensively using `with` or `if` to handle entries where `params.class` is not defined. @@ -118,10 +118,10 @@ Hugo provides two methods to localize your menu entries. See [multilingual]. [automatic]: /content-management/menus/#define-automatically [define menu entries]: /content-management/menus/ [defining menu entries]: /content-management/menus/ -[in front matter]: /content-management/menus/#define-in-front-matter -[in site configuration]: /content-management/menus/#define-in-site-configuration +[front matter]: /content-management/menus/#define-in-front-matter [localize the menu entries]: /content-management/multilingual/#menus [menu entry defined in front matter]: /content-management/menus/#example -[menu entry defined in site configuration]: /configuration/menus +[menu entry defined in your project configuration]: /configuration/menus [menu methods]: /methods/menu/ [multilingual]: /content-management/multilingual/#menus +[project configuration]: /content-management/menus/#define-in-project-configuration diff --git a/content/en/templates/pagination.md b/content/en/templates/pagination.md index a1174980d5..3891da5747 100644 --- a/content/en/templates/pagination.md +++ b/content/en/templates/pagination.md @@ -47,7 +47,7 @@ The `Paginate` method is more flexible, allowing you to: - Paginate any page collection - Filter, sort, and group the page collection -- Override the number of pages per pager as defined in your site configuration +- Override the number of pages per pager as defined in your project configuration By comparison, the `Paginator` method paginates the page collection passed into the template, and you cannot override the number of pages per pager. @@ -163,7 +163,7 @@ content/ └── _index.md ``` -And this site configuration: +And this project configuration: {{< code-toggle file=hugo >}} [pagination] @@ -204,7 +204,7 @@ public/ └── index.html ``` -To disable alias generation for the first pager, change your site configuration: +To disable alias generation for the first pager, change your project configuration: {{< code-toggle file=hugo >}} [pagination] diff --git a/content/en/templates/robots.md b/content/en/templates/robots.md index 75bd8bbce9..00ca20e41c 100644 --- a/content/en/templates/robots.md +++ b/content/en/templates/robots.md @@ -8,7 +8,7 @@ weight: 190 aliases: [/extras/robots-txt/] --- -To generate a robots.txt file from a template, change the [site configuration]: +To generate a robots.txt file from a template, change your [project configuration]: {{< code-toggle file=hugo >}} enableRobotsTXT = true @@ -43,10 +43,10 @@ This template creates a robots.txt file with a `Disallow` directive for each pag > [!note] > To create a robots.txt file without using a template: > -> 1. Set `enableRobotsTXT` to `false` in the site configuration. +> 1. Set `enableRobotsTXT` to `false` in your project configuration. > 1. Create a robots.txt file in the `static` directory. > -> Remember that Hugo copies everything in the static director to the root of `publishDir` (typically `public`) when you build your site. +> Remember that Hugo copies everything in the static director to the root of `publishDir` (typically `public`) when you build your project. [embedded template]: <{{% eturl robots %}}> -[site configuration]: /configuration/ +[project configuration]: /configuration/ diff --git a/content/en/templates/rss.md b/content/en/templates/rss.md index cbc393a033..e0c64e421a 100644 --- a/content/en/templates/rss.md +++ b/content/en/templates/rss.md @@ -8,7 +8,7 @@ weight: 140 ## Configuration -By default, when you build your site, Hugo generates RSS feeds for home, section, taxonomy, and term pages. Control feed generation in your site configuration. For example, to generate feeds for home and section pages, but not for taxonomy and term pages: +By default, when you build your project, Hugo generates RSS feeds for home, section, taxonomy, and term pages. Control feed generation in your project configuration. For example, to generate feeds for home and section pages, but not for taxonomy and term pages: {{< code-toggle file=hugo >}} [outputs] @@ -24,7 +24,7 @@ To disable feed generation for all [page kinds](g): disableKinds = ['rss'] {{< /code-toggle >}} -By default, the number of items in each feed is unlimited. Change this as needed in your site configuration: +By default, the number of items in each feed is unlimited. Change this as needed in your project configuration: {{< code-toggle file=hugo >}} [services.rss] @@ -33,7 +33,7 @@ limit = 42 Set `limit` to `-1` to generate an unlimited number of items per feed. -The built-in RSS template will render the following values, if present, from your site configuration: +The built-in RSS template will render the following values, if present, from your project configuration: {{< code-toggle file=hugo >}} copyright = '© 2023 ABC Widgets, Inc.' diff --git a/content/en/templates/sitemap.md b/content/en/templates/sitemap.md index a79ec7bbaf..221cb6c0fa 100644 --- a/content/en/templates/sitemap.md +++ b/content/en/templates/sitemap.md @@ -42,7 +42,7 @@ To override the built-in sitemapindex.xml template, create a new `layouts/sitema ## Disable sitemap generation -You may disable sitemap generation in your site configuration: +You may disable sitemap generation in your project configuration: {{< code-toggle file=hugo >}} disableKinds = ['sitemap'] diff --git a/content/en/troubleshooting/audit/index.md b/content/en/troubleshooting/audit/index.md index 2efad55e36..a20b33651a 100644 --- a/content/en/troubleshooting/audit/index.md +++ b/content/en/troubleshooting/audit/index.md @@ -23,10 +23,10 @@ _Tested with GNU Bash 5.1 and GNU grep 3.7._ ### Environment variables `HUGO_MINIFY_TDEWOLFF_HTML_KEEPCOMMENTS=true` -: Retain HTML comments even if minification is enabled. This takes precedence over `minify.tdewolff.html.keepComments` in the site configuration. If you minify without keeping HTML comments when performing this audit, you will not be able to detect when raw HTML has been omitted. +: Retain HTML comments even if minification is enabled. This takes precedence over `minify.tdewolff.html.keepComments` in your project configuration. If you minify without keeping HTML comments when performing this audit, you will not be able to detect when raw HTML has been omitted. `HUGO_ENABLEMISSINGTRANSLATIONPLACEHOLDERS=true` -: Show a placeholder instead of the default value or an empty string if a translation is missing. This takes precedence over `enableMissingTranslationPlaceholders` in the site configuration. +: Show a placeholder instead of the default value or an empty string if a translation is missing. This takes precedence over `enableMissingTranslationPlaceholders` in your project configuration. ### Grep options