Merge 8a8b30824374e633142111e9f3d88c316cecd7a9 into 97e035006b0a721915eebf2026dde0ec4ef7bb5b

This commit is contained in:
Joe Mooring 2025-07-31 21:10:19 -05:00 committed by GitHub
commit 7bcdee21a0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 241 additions and 2 deletions

View File

@ -59,10 +59,26 @@ dataDir
: (`string`) The designated directory for data files. Default is `data`. {{% module-mounts-note %}}
defaultContentLanguage
: (`string`) The project's default language key, conforming to the syntax described in [RFC 5646]. This value must match one of the defined language keys. Default is `en`.
: (`string`) The project's default content language key, conforming to the syntax described in [RFC 5646]. This value must match one of the defined language keys. Default is `en`.
defaultContentLanguageInSubdir
: (`bool`) Whether to publish the default language site to a subdirectory matching the `defaultContentLanguage`. Default is `false`.
: (`bool`) Whether to publish the default content language site to a subdirectory matching the `defaultContentLanguage`. Default is `false`.
defaultContentRole
: {{< new-in 0.149.0 />}}
: (`string`) The site's default content role. Default is `guest`.
defaultContentRoleInSubdir
: {{< new-in 0.149.0 />}}
: (`bool`) Whether to publish the default content role to a subdirectory matching the `defaultContentRole`. Default is `false`.
defaultContentVersion
: {{< new-in 0.149.0 />}}
: (`string`) The site's default content version. Default is `TODO`.
defaultContentVersionInSubdir
: {{< new-in 0.149.0 />}}
: (`bool`) Whether to publish the default content version to a subdirectory matching the `defaultContentVersion`. Default is `false`.
defaultOutputFormat
: (`string`) The default output format for the site. If unspecified, the first available format in the defined order (by weight, then alphabetically) will be used.
@ -240,6 +256,9 @@ renderSegments
resourceDir
: (`string`) The designated directory for caching output from [asset pipelines](g). Default is `resources`.
roles
: See [configure roles](/configuration/roles/).
security
: See [configure security](/configuration/security/).
@ -294,6 +313,9 @@ titleCaseStyle
uglyurls
: See [configure ugly URLs](/configuration/ugly-urls/).
versions
: See [configure versions](/configuration/versions/).
## Cache directory
Hugo's file cache directory is configurable via the [`cacheDir`] configuration option or the `HUGO_CACHEDIR` environment variable. If neither is set, Hugo will use, in order of preference:

View File

@ -0,0 +1,13 @@
---
title: Configure roles
linkTitle: Roles
description: Configure roles.
categories: []
keywords: []
---
{{< new-in 0.149.0 />}}
This is the default configuration:
{{< code-toggle config=rolls />}}

View File

@ -0,0 +1,13 @@
---
title: Configure versions
linkTitle: Versions
description: Configure versions.
categories: []
keywords: []
---
{{< new-in 0.149.0 />}}
This is the default configuration:
{{< code-toggle config=versions />}}

View File

@ -0,0 +1,47 @@
---
title: Dimensions
description: TODO
categories: []
keywords: []
---
{{< new-in 0.149.0 />}}
TODO
<!-- TODO we may not need some of these sentences -->
See [configure languages](/configuration/languages/).
See [configure roles](/configuration/roles/).
See [configure versions](/configuration/versions/).
<!-- TODO we may not need some of these references -->
<!-- site config -->
[`defaultContentLanguage`]: /configuration/all/#defaultcontentlanguage
[`defaultContentLanguageInSubdir`]: /configuration/all/#defaultcontentlanguageinsubdir
[`defaultContentRoleInSubdir`]: /configuration/all/#defaultcontentrole
[`defaultContentRole`]: /configuration/all/#defaultcontentrole
[`defaultContentRoleInSubdir`]: /configuration/all/#defaultcontentrole
[`defaultContentVersion`]: /configuration/all/#defaultcontentversion
[`defaultContentVersionInSubdir`]: /configuration/all/#defaultcontentversioninsubdir
<!-- site methods -->
[`Dimension`]: /methods/site/dimension/
[`Language`]: /methods/site/language/
[`Languages`]: /methods/site/languages/
[`Role`]: /methods/site/role/
[`Roles`]: /methods/site/roles/
[`Version`]: /methods/site/version/
[`Versions`]: /methods/site/versions/
<!-- front matter -->
[front matter languageDelegees]: /content-management/front-matter/#languagedelegees
[front matter languages]: /content-management/front-matter/#languages
[front matter roleDelegees]: /content-management/front-matter/#roledelegees
[front matter roles]: /content-management/front-matter/#roles
[front matter versionDelegees]: /content-management/front-matter/#versiondelegees
[front matter versions]: /content-management/front-matter/#versions

View File

@ -74,6 +74,14 @@ isCJKLanguage
keywords
: (`string array`) An array of keywords, typically rendered within a `meta` element within the `head` element of the published HTML file, or used as a [taxonomy](g) to classify content. Access these values from a template using the [`Keywords`] method on a `Page` object.
languageDelegees
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
languages
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
lastmod
: (`string`) The date that the page was last modified. Note that the TOML format also supports unquoted date/time values. See the [dates](#dates) section for examples. Access this value from a template using the [`Lastmod`] method on a `Page` object.
@ -111,6 +119,14 @@ published
resources
: (`map array`) An array of maps to provide metadata for [page resources].
roleDelegees
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
roles
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
sitemap
: (`map`) A map of sitemap options. See the [sitemap templates] page for details. Access these values from a template using the [`Sitemap`] method on a `Page` object.
@ -135,6 +151,14 @@ unpublishdate
url
: (`string`) Overrides the entire URL path. Applicable to regular pages and section pages. See the [URL management] page for details.
versionDelegees
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
versions
: {{< new-in 0.149.0 />}}
: (`TODO`) TODO.
weight
: (`int`) The page [weight](g), used to order the page within a [page collection](g). Access this value from a template using the [`Weight`] method on a `Page` object.

View File

@ -0,0 +1,20 @@
---
title: Rotate
description: TODO
categories: []
keywords: []
params:
functions_and_methods:
returnType: page.Pages
signatures: [PAGE.Rotate DIMENSION]
---
{{< new-in 0.149.0 />}}
TODO
<!-- DIMENSION must be one of language, role, or version. -->
```go-html-template
{{ .Rotate "language" }}
```

View File

@ -0,0 +1,28 @@
---
title: Dimension
description: TODO
categories: []
keywords: []
params:
functions_and_methods:
returnType: TODO
signatures: [SITE.Dimension DIMENSION]
---
{{< new-in 0.149.0 />}}
TODO
<!--
Not sure how to document the returned data type; it changes based on the
argument, e.g.,
{{ .Site.Dimension "language" }} => langs.Language
{{ .Site.Dimension "role" }} => roles.RoleSite
{{ .Site.Dimension "version" }} => versions.VersionSite
-->
<!-- DIMENSION must be one of language, role, or version. -->
```go-html-template
{{ .Site.Dimension "language" }}
```

View File

@ -0,0 +1,18 @@
---
title: Role
description: Returns the role configured for this site.
categories: []
keywords: []
params:
functions_and_methods:
returnType: roles.RoleSite
signatures: [SITE.Role]
---
{{< new-in 0.149.0 />}}
TODO
```go-html-template
{{ .Site.Role }}
```

View File

@ -0,0 +1,18 @@
---
title: Roles
description: Returns the roles configured for this site.
categories: []
keywords: []
params:
functions_and_methods:
returnType: roles.Roles
signatures: [SITE.Roles]
---
{{< new-in 0.149.0 />}}
TODO
```go-html-template
{{ .Site.Roles }}
```

View File

@ -0,0 +1,18 @@
---
title: Version
description: Returns the version configured for this site.
categories: []
keywords: []
params:
functions_and_methods:
returnType: versions.VersionSite
signatures: [SITE.Version]
---
{{< new-in 0.149.0 />}}
TODO
```go-html-template
{{ .Site.Version }}
```

View File

@ -0,0 +1,18 @@
---
title: Versions
description: Returns the versions configured for this site.
categories: []
keywords: []
params:
functions_and_methods:
returnType: versions.Versions
signatures: [SITE.Versions]
---
{{< new-in 0.149.0 />}}
TODO
```go-html-template
{{ .Site.Versions }}
```