Skip to content

Commit bbe58f6

Browse files
committed
content: Miscellaneous edits to configuration documentation
Closes gohugoio#3351
1 parent 19a5808 commit bbe58f6

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

content/en/configuration/all.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ deployment
8686
: See [configure deployment][].
8787

8888
disableAliases
89-
: (`bool`) Whether to disable generation of alias redirects. Even if this option is enabled, the defined aliases will still be present on the page. This allows you to manage redirects separately, for example, by generating 301 redirects in an `.htaccess` file or a Netlify `_redirects` file using a custom output format. Default is `false`.
89+
: (`bool`) Whether to disable the generation of HTML redirect files for each path defined in the [`aliases`][aliases_front_matter] front matter field. When `true`, Hugo will not create physical files for [client-side redirection][], but the alias data remains available via the [`Aliases`][aliases_page_method] method on a `Page` object. Default is `false`.
9090

9191
disableDefaultLanguageRedirect
9292
: {{< new-in 0.140.0 />}}
@@ -378,9 +378,12 @@ Some configuration settings, such as menus and custom parameters, can be defined
378378
[`titleCaseStyle`]: #titlecasestyle
379379
[`warnidf`]: /functions/fmt/warnidf/
380380
[`WordCount`]: /methods/page/wordcount/
381+
[aliases_front_matter]: /content-management/front-matter/#aliases
382+
[aliases_page_method]: /methods/page/aliases/
381383
[Associated Press Stylebook]: https://www.apstylebook.com/
382384
[automatic summaries]: /content-management/summaries/#automatic-summary
383385
[Chicago Manual of Style]: https://www.chicagomanualofstyle.org/home.html
386+
[client-side redirection]: /content-management/urls/#client-side-redirection
384387
[composite characters]: https://en.wikipedia.org/wiki/Precomposed_character
385388
[configure build]: /configuration/build/
386389
[configure cascade]: /configuration/cascade/

content/en/configuration/markup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ renderHooks.image.useEmbedded
174174
: {{< new-in 0.148.0 />}}
175175
: (`string`) When to use the [embedded image render hook]. One of `auto`, `never`, `always`, or `fallback`. Default is `auto`.
176176

177-
- `auto`: Automatically use the embedded image render hook for multilingual single-host sites, specifically when the [duplication of shared page resources] feature is disabled. This is the default behavior for such sites. If custom image render hooks are defined by your project, modules, or themes, these will be used instead.
177+
- `auto`: Use the embedded image render hook only for multilingual single-host projects where all languages share the same `baseURL`, specifically when the [duplication of shared page resources] feature is disabled. If custom image render hooks are defined by your project, modules, or themes, these will be used instead.
178178
- `never`: Never use the embedded image render hook. If custom image render hooks are defined by your project, modules, or themes, these will be used instead.
179-
- `always`: Always use the embedded image render hook, even if custom image render hooks are provided by your project, modules, or themes. In this case, the embedded hook takes precedence.
179+
- `always`: Always use the embedded image render hook, even if custom image render hooks are provided by your project, modules, or themes.
180180
- `fallback`: Use the embedded image render hook only if custom image render hooks are not provided by your project, modules, or themes. If custom image render hooks exist, these will be used instead.
181181

182182
<!-- TODO: delete this on or after July 1, 2027. -->
@@ -186,9 +186,9 @@ renderHooks.link.enableDefault
186186
renderHooks.link.useEmbedded
187187
: (`string`) When to use the [embedded link render hook]. One of `auto`, `never`, `always`, or `fallback`. Default is `auto`.
188188

189-
- `auto`: Automatically use the embedded link render hook for multilingual single-host sites, specifically when the [duplication of shared page resources] feature is disabled. This is the default behavior for such sites. If custom link render hooks are defined by your project, modules, or themes, these will be used instead.
189+
- `auto`: Use the embedded link render hook only for multilingual single-host projects where all languages share the same `baseURL`, specifically when the [duplication of shared page resources] feature is disabled. If custom link render hooks are defined by your project, modules, or themes, these will be used instead.
190190
- `never`: Never use the embedded link render hook. If custom link render hooks are defined by your project, modules, or themes, these will be used instead.
191-
- `always`: Always use the embedded link render hook, even if custom link render hooks are provided by your project, modules, or themes. In this case, the embedded hook takes precedence.
191+
- `always`: Always use the embedded link render hook, even if custom link render hooks are provided by your project, modules, or themes.
192192
- `fallback`: Use the embedded link render hook only if custom link render hooks are not provided by your project, modules, or themes. If custom link render hooks exist, these will be used instead.
193193

194194
renderer.hardWraps

0 commit comments

Comments
 (0)