Update site configuration docs

This commit is contained in:
Joe Mooring 2024-05-07 13:56:14 -07:00 committed by GitHub
parent 1dbe9ee200
commit 417e869f00
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -248,7 +248,7 @@ To remain consistent and prevent unexpected behavior, do not mix these strategie
###### canonifyURLs
(`bool`) Enable to turn relative URLs into absolute. Default is `false`. See [details](/content-management/urls/#canonical-urls).
(`bool`) See [details](/content-management/urls/#canonical-urls) before enabling this feature. Default is `false`.
###### cleanDestinationDir
@ -395,20 +395,6 @@ See [Content Management](/content-management/urls/#permalinks).
(`string`) The directory to where Hugo will write the final static site (the HTML files etc.). Default is `public`.
###### related
See [Related Content](/content-management/related/#configure-related-content).
###### relativeURLs
(`bool`) Enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. Default is `false`. See [details](/content-management/urls/#relative-urls).
###### renderSegments
(`string slice`) A list of segments to render. If not set, everything will be rendered. This is more commonly set in a CLI flag, e.g. `hugo --renderSegments segment1,segment2`.
The segment names must match the names in the [segments](#configure-segments) configuration.
###### refLinksErrorLevel
(`string`) When using `ref` or `relref` to resolve page links and a link cannot be resolved, it will be logged with this log level. Valid values are `ERROR` (default) or `WARNING`. Any `ERROR` will fail the build (`exit -1`). Default is `ERROR`.
@ -417,6 +403,20 @@ The segment names must match the names in the [segments](#configure-segments) co
(`string`) URL to be used as a placeholder when a page reference cannot be found in `ref` or `relref`. Is used as-is.
###### related
See [Related Content](/content-management/related/#configure-related-content).
###### relativeURLs
(`bool`) See [details](/content-management/urls/#relative-urls) before enabling this feature. Default is `false`.
###### renderSegments
{{< new-in 0.124.0 >}}
(`string slice`) A list of segments to render. If not set, everything will be rendered. This is more commonly set in a CLI flag, e.g. `hugo --renderSegments segment1,segment2`. The segment names must match the names in the [segments](#configure-segments) configuration.
###### removePathAccents
(`bool`) Removes [non-spacing marks](https://www.compart.com/en/unicode/category/Mn) from [composite characters](https://en.wikipedia.org/wiki/Precomposed_character) in content paths. Default is `false`.