Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/_common/menu-entries/pre-and-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions content/en/_common/methods/page/next-and-prev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions content/en/_common/methods/resource/processing-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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
:--|:--
Expand All @@ -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
:--|:--
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion content/en/_common/ref-and-relref-error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 2 additions & 2 deletions content/en/configuration/front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand All @@ -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]
Expand Down
10 changes: 5 additions & 5 deletions content/en/configuration/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ 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/
└── hugo.toml
```

> [!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:

Expand Down Expand Up @@ -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/
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -260,7 +260,7 @@ HUGO_NUMWORKERMULTIPLIER

## Current configuration

Display the complete site configuration with:
Display the complete project configuration with:

```sh
hugo config
Expand Down
2 changes: 1 addition & 1 deletion content/en/configuration/languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions content/en/configuration/markup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
:--|:--
Expand Down Expand Up @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions content/en/configuration/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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/
6 changes: 3 additions & 3 deletions content/en/configuration/output-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`.
Expand All @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion content/en/configuration/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 />}}

Expand Down
2 changes: 1 addition & 1 deletion content/en/configuration/permalinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ content/
└── _index.md
```

And this site configuration:
And this project configuration:

{{< code-toggle file=hugo >}}
defaultContentLanguage = 'en'
Expand Down
4 changes: 2 additions & 2 deletions content/en/configuration/related-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/en/configuration/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/en/configuration/taxonomies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down
4 changes: 2 additions & 2 deletions content/en/content-management/content-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -305,7 +305,7 @@ content/

### Translations by content directory

With this site configuration:
With this project configuration:

{{< code-toggle file=hugo >}}
[languages.en]
Expand Down
Loading