Skip to content

Commit 9243e9f

Browse files
committed
content: Rename site configuration to project configuration (phase 2)
1 parent 330aa22 commit 9243e9f

File tree

137 files changed

+297
-297
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+297
-297
lines changed

content/en/_common/menu-entries/pre-and-post.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
_comment: Do not remove front matter.
33
---
44

5-
In this site configuration we enable rendering of [emoji shortcodes], and add emoji shortcodes before (pre) and after (post) each menu entry:
5+
In this project configuration we enable rendering of [emoji shortcodes], and add emoji shortcodes before (pre) and after (post) each menu entry:
66

77
{{< code-toggle file=hugo >}}
88
enableEmoji = true

content/en/_common/methods/page/next-and-prev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ When you visit page-2:
5353
- The `Prev` method points to page-3
5454
- The `Next` method points to page-1
5555

56-
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.
56+
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.
5757

58-
[site configuration]: /configuration/page/
58+
[project configuration]: /configuration/page/
5959
[`Next`]: /methods/pages/prev
6060
[`Prev`]: /methods/pages/prev

content/en/_common/methods/page/nextinsection-and-previnsection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ When you visit page-2:
5353
- The `PrevInSection` method points to page-3
5454
- The `NextInSection` method points to page-1
5555

56-
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.
56+
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.
5757

58-
[site configuration]: /configuration/page/
58+
[project configuration]: /configuration/page/
5959
[`Next`]: /methods/pages/prev
6060
[`Prev`]: /methods/pages/prev
6161

content/en/_common/methods/resource/processing-spec.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ action
1010
: 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.
1111

1212
anchor
13-
: 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.
13+
: 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.
1414

1515
background color
16-
: 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.
16+
: 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.
1717

1818
compression
1919
: {{< new-in 0.153.5 />}}
20-
: 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.
20+
: 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.
2121

2222
dimensions
2323
: 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
2626
: 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.
2727

2828
hint
29-
: 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.
29+
: 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.
3030

3131
Value|Example
3232
:--|:--
@@ -37,10 +37,10 @@ hint
3737
`text`|Image that is primarily text
3838

3939
quality
40-
: 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.
40+
: 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.
4141

4242
resampling filter
43-
: 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.
43+
: 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.
4444

4545
Filter|Description
4646
:--|:--
@@ -56,7 +56,7 @@ resampling filter
5656
rotation
5757
: 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.
5858

59-
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.
59+
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.
6060

6161
[`anchor`]: /configuration/imaging/#anchor
6262
[`bgcolor`]: /configuration/imaging/#bgcolor

content/en/_common/methods/taxonomy/get-a-taxonomy-object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Before we can use a `Taxonomy` method, we need to capture a `Taxonomy` object.
66

77
## Capture a Taxonomy object
88

9-
Consider this site configuration:
9+
Consider this project configuration:
1010

1111
{{< code-toggle file=hugo >}}
1212
[taxonomies]

content/en/_common/ref-and-relref-error-handling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
_comment: Do not remove front matter.
33
---
44

5-
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.
5+
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.
66

77
{{< code-toggle file=hugo >}}
88
refLinksErrorLevel = 'warning'

content/en/configuration/front-matter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Hugo provides the following [tokens](g) to help you configure your front matter:
7676

7777
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`).
7878

79-
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.
79+
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.
8080

8181
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`.
8282

@@ -85,7 +85,7 @@ Hugo provides the following [tokens](g) to help you configure your front matter:
8585

8686
## Example
8787

88-
Consider this site configuration:
88+
Consider this project configuration:
8989

9090
{{< code-toggle file=hugo >}}
9191
[frontmatter]

content/en/configuration/introduction.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ Only define settings that deviate from the defaults. A smaller configuration fil
2323
2424
## Configuration file
2525

26-
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.
26+
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.
2727

2828
```text
2929
my-project/
3030
└── hugo.toml
3131
```
3232

3333
> [!note]
34-
> 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`.
34+
> 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`.
3535
3636
A simple example:
3737

@@ -63,7 +63,7 @@ hugo build --config a.toml,b.yaml,c.json
6363
6464
## Configuration directory
6565

66-
Instead of a single site configuration file, split your configuration by [environment](g), root configuration key, and language. For example:
66+
Instead of a single project configuration file, split your configuration by [environment](g), root configuration key, and language. For example:
6767

6868
```text
6969
my-project/
@@ -131,7 +131,7 @@ my-project/
131131

132132
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.
133133

134-
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:
134+
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:
135135

136136
{{< code-toggle file=hugo >}}
137137
[services.googleAnalytics]
@@ -260,7 +260,7 @@ HUGO_NUMWORKERMULTIPLIER
260260

261261
## Current configuration
262262

263-
Display the complete site configuration with:
263+
Display the complete project configuration with:
264264

265265
```sh
266266
hugo config

content/en/configuration/languages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The following configuration keys can be defined separately for each language:
9292

9393
{{< per-lang-config-keys >}}
9494

95-
Any key not defined in a `languages` object will fall back to the global value in the root of the site configuration.
95+
Any key not defined in a `languages` object will fall back to the global value in the root of your project configuration.
9696

9797
## Language keys
9898

content/en/configuration/markup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ defaultMarkdownHandler = 'goldmark'
1818

1919
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.
2020

21-
To use a different renderer for Markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your site configuration.
21+
To use a different renderer for Markdown files, specify one of `asciidocext`, `org`, `pandoc`, or `rst` in your project configuration.
2222

2323
`defaultMarkdownHandler`|Renderer
2424
:--|:--
@@ -255,7 +255,7 @@ workingFolderCurrent
255255
Follow the steps below to enable syntax highlighting.
256256

257257
Step 1
258-
: Set the `source-highlighter` attribute in your site configuration. For example:
258+
: Set the `source-highlighter` attribute in your project configuration. For example:
259259

260260
{{< code-toggle file=hugo >}}
261261
[markup.asciidocExt.attributes]

0 commit comments

Comments
 (0)