mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-13 16:41:02 -04:00
Improve glossary
This commit is contained in:
parent
6a7fd42ff7
commit
d847892aa5
@ -1,19 +1,12 @@
|
||||
---
|
||||
title: {{ replace .File.ContentBaseName "-" " " }}
|
||||
reference:
|
||||
---
|
||||
|
||||
<!--
|
||||
You can insert these definitions in other pages using the `glossary-term` shortcode, so they must be self-contained.
|
||||
Glossary terms are maintained on dedicated individual pages within the documentation. These pages act as a central repository for all term definitions, although they are not directly visible to site visitors.
|
||||
|
||||
Do this:
|
||||
Definitions must be presented in complete sentences, with the first sentence always explicitly introducing the term being defined. The first occurrence of the term itself, along with any other referenced glossary terms, should be presented in italics within the definition. However, when a term is an alias for another term, the definition can simply state "See [page kind]" (e.g., "See [page kind]"). These guidelines aim to enhance the readability and consistency of all glossary definitions.
|
||||
|
||||
A _foo_ is big bar.
|
||||
|
||||
Not this:
|
||||
|
||||
A big bar.
|
||||
|
||||
Italicize the term whenever you use it in the definition.
|
||||
|
||||
An exception to this rule occurs when a term is an alias for another. In such cases, it is sufficient to use the phrase 'See [page kind]'."
|
||||
The "reference" field in the front matter of each definition page should be used to include a "See details" link at the end of the definition. This allows for flexible placement of the definition within the documentation while maintaining a central source for the definition itself. The value in the "reference" field must correspond to the logical path of the relevant page within the documentation structure.
|
||||
-->
|
||||
|
@ -76,13 +76,13 @@ Date
|
||||
: (`string`) The current date and time, formatted in compliance with RFC3339.
|
||||
|
||||
File
|
||||
: (`hugolib.fileInfo`) Returns file information for the current page. See [details](/methods/page/file).
|
||||
: (`hugolib.fileInfo`) Returns file information for the current page. See [details](/methods/page/file).
|
||||
|
||||
Type
|
||||
: (`string`) The [content type](g) inferred from the top-level directory name, or as specified by the `--kind` flag passed to the `hugo new content` command.
|
||||
|
||||
Site
|
||||
: (`page.Site`) The current site object. See [details](/methods/site/).
|
||||
: (`page.Site`) The current site object. See [details](/methods/site/).
|
||||
|
||||
## Date format
|
||||
|
||||
|
@ -74,7 +74,7 @@ Create your content in [HTML] preceded by front matter. The content is typically
|
||||
|
||||
### Emacs Org Mode
|
||||
|
||||
Create your content in the [Emacs Org Mode] format preceded by front matter. You can use Org Mode keywords for front matter. See [details].
|
||||
Create your content in the [Emacs Org Mode] format preceded by front matter. You can use Org Mode keywords for front matter. See [details].
|
||||
|
||||
[details]: /content-management/front-matter/#emacs-org-mode
|
||||
[Emacs Org Mode]: https://orgmode.org/
|
||||
|
@ -17,7 +17,7 @@ To process an image you must access the file as a page resource, global resource
|
||||
|
||||
### Page resource
|
||||
|
||||
A page resource is a file within a [page bundle]. A page bundle is a directory with an `index.md` or `_index.md` file at its root.
|
||||
A page resource is a file within a [page bundle]. A page bundle is a directory with an `index.md` or `_index.md` file at its root.
|
||||
|
||||
```text
|
||||
content/
|
||||
|
@ -30,10 +30,10 @@ The "about" page is a page bundle. It logically associates a resource with conte
|
||||
Page bundles are either _leaf bundles_ or _branch bundles_.
|
||||
|
||||
leaf bundle
|
||||
: A _leaf bundle_ is a directory that contains an `index.md` file and zero or more resources. Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants.
|
||||
: A _leaf bundle_ is a directory that contains an `index.md` file and zero or more resources. Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants.
|
||||
|
||||
branch bundle
|
||||
: A _branch bundle_ is a directory that contains an `_index.md` file and zero or more resources. Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page.
|
||||
: A _branch bundle_ is a directory that contains an `_index.md` file and zero or more resources. Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page.
|
||||
|
||||
{{% note %}}
|
||||
In the definitions above and the examples below, the extension of the index file depends on the [content format](g). For example, use `index.md` for Markdown content, `index.html` for HTML content, `index.adoc` for AsciiDoc content, etc.
|
||||
@ -63,7 +63,7 @@ Files with [resource type](g) `page` include content written in Markdown, HTML,
|
||||
|
||||
## Leaf bundles
|
||||
|
||||
A _leaf bundle_ is a directory that contains an `index.md` file and zero or more resources. Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants.
|
||||
A _leaf bundle_ is a directory that contains an `index.md` file and zero or more resources. Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants.
|
||||
|
||||
```text
|
||||
content/
|
||||
@ -114,7 +114,7 @@ Create leaf bundles at any depth within the `content` directory, but a leaf bund
|
||||
|
||||
## Branch bundles
|
||||
|
||||
A _branch bundle_ is a directory that contains an `_index.md` file and zero or more resources. Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page.
|
||||
A _branch bundle_ is a directory that contains an `_index.md` file and zero or more resources. Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page.
|
||||
|
||||
```text
|
||||
content/
|
||||
|
@ -12,7 +12,7 @@ toc: true
|
||||
---
|
||||
|
||||
Page resources are only accessible from [page bundles](/content-management/page-bundles), those directories with `index.md` or
|
||||
`_index.md` files at their root. Page resources are only available to the
|
||||
`_index.md` files at their root. Page resources are only available to the
|
||||
page with which they are bundled.
|
||||
|
||||
In this example, `first-post` is a page bundle with access to 10 page resources including audio, data, documents, images, and video. Although `second-post` is also a page bundle, it has no page resources and is unable to directly access the page resources associated with `first-post`.
|
||||
|
@ -15,10 +15,10 @@ aliases: [/content/sections/]
|
||||
|
||||
## Overview
|
||||
|
||||
A section is a top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle](g). Section templates receive one or more page [collections](g) in [context](g).
|
||||
A section is a top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle](g). Section templates receive one or more page [collections](g) in [context](g).
|
||||
|
||||
{{% note %}}
|
||||
Although top-level directories without `_index.md` files are sections, we recommend creating `_index.md` files in _all_ sections.
|
||||
Although top-level directories without `_index.md` files are sections, we recommend creating `_index.md` files in _all_ sections.
|
||||
{{% /note %}}
|
||||
|
||||
A typical site consists of one or more sections. For example:
|
||||
|
@ -43,7 +43,9 @@ Please follow these guidelines:
|
||||
|
||||
### Glossary of terms
|
||||
|
||||
Each term in the glossary has its own dedicated page located within the `content/en/getting-started/glossary` directory. While these individual glossary pages are not published as standalone web pages during the build process, their content is included in other pages as needed.
|
||||
Glossary terms are maintained on individual pages. While not directly accessible to site visitors, these pages act as a central repository for term definitions.
|
||||
|
||||
Definitions must be presented in complete sentences, with the first sentence always introducing the term being defined. To enhance readability and consistency, the first occurrence of the term and any other referenced glossary terms should be italicized.
|
||||
|
||||
To link to a term definition on the glossary page, use this custom link syntax:
|
||||
|
||||
|
@ -228,13 +228,13 @@ See [Configure File Caches](#configure-file-caches).
|
||||
|
||||
###### canonifyURLs
|
||||
|
||||
(`bool`) See [details](/content-management/urls/#canonical-urls) before enabling this feature. Default is `false`.
|
||||
(`bool`) See [details](/content-management/urls/#canonical-urls) before enabling this feature. Default is `false`.
|
||||
|
||||
###### capitalizeListTitles
|
||||
|
||||
{{< new-in 0.123.3 >}}
|
||||
|
||||
(`bool`) Whether to capitalize automatic list titles. Applicable to section, taxonomy, and term pages. Default is `true`. You can change the capitalization style in your site configuration to one of `ap`, `chicago`, `go`, `firstupper`, or `none`. See [details].
|
||||
(`bool`) Whether to capitalize automatic list titles. Applicable to section, taxonomy, and term pages. Default is `true`. You can change the capitalization style in your site configuration to one of `ap`, `chicago`, `go`, `firstupper`, or `none`. See [details].
|
||||
|
||||
[details]: /getting-started/configuration/#configure-title-case
|
||||
|
||||
@ -460,7 +460,7 @@ 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`.
|
||||
(`bool`) See [details](/content-management/urls/#relative-urls) before enabling this feature. Default is `false`.
|
||||
|
||||
###### removePathAccents
|
||||
|
||||
@ -541,7 +541,7 @@ See [module configuration](/hugo-modules/configuration/#module-configuration-imp
|
||||
|
||||
###### uglyURLs
|
||||
|
||||
(`bool` or `map`) Whether to generate uglyURLs. Default is `false`. See [details](/content-management/urls/#appearance).
|
||||
(`bool` or `map`) Whether to generate uglyURLs. Default is `false`. See [details](/content-management/urls/#appearance).
|
||||
|
||||
###### watch
|
||||
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: archetype
|
||||
details: /content-management/archetypes
|
||||
---
|
||||
|
||||
An archetype is a template for new content. See [details](/content-management/archetypes/).
|
||||
An _archetype_ is a template for new content.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: argument
|
||||
---
|
||||
|
||||
A [scalar](g), [array](g), [slice](g), [map](g), or [object](g) passed to a [function](g), [method](g), or [shortcode](g).
|
||||
An _argument_ is a [_scalar_](g), [_array_](g), [_slice_](g), [_map_](g), or [_object_](g) passed to a [_function_](g), [_method_](g), or [_shortcode_](g).
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: array
|
||||
---
|
||||
|
||||
A numbered sequence of [elements](g). Unlike Go's [slice](g) data type, an array has a fixed length. Elements within an array can be [scalars](g), slices, [maps](g), pages, or other arrays. See the [Go documentation](https://go.dev/ref/spec#Array_types) for details.
|
||||
An _array_ is a numbered sequence of [_elements_](g). Unlike Go's [_slice_](g) data type, an array has a fixed length. Elements within an array can be [_scalars_](g), slices, [_maps_](g), pages, or other arrays.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: boolean
|
||||
---
|
||||
|
||||
A data type with two possible values, either `true` or `false`.
|
||||
A _boolean_ is a data type with two possible values, either `true` or `false`.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: branch bundle
|
||||
reference: /content-management/page-bundles
|
||||
---
|
||||
|
||||
A directory that contains an `_index.md` file and zero or more [resources](g). Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page. See [details](/content-management/page-bundles/).
|
||||
A _branch bundle_ is a top-level content directory or any content directory containing an `_index.md` file. Analogous to a physical branch, a branch bundle may have descendants including [_leaf bundles_](g) and other branch bundles. A branch bundle may also contain [_page resources_](g) such as images.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: build
|
||||
---
|
||||
|
||||
To generate a static site that includes HTML files and assets such as images, CSS, and JavaScript. The build process includes rendering and resource transformations.
|
||||
To _build_ a site is to generate HTML files and assets such as images, CSS files, and JavaScript files. The build process includes rendering and resource transformations.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: CJK
|
||||
---
|
||||
|
||||
A collective term for the Chinese, Japanese, and Korean languages. See [details](https://en.wikipedia.org/wiki/CJK_characters).
|
||||
A collective term for the Chinese, Japanese, and Korean languages.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: content adapter
|
||||
reference: /content-management/content-adapters
|
||||
---
|
||||
|
||||
A template that dynamically creates pages when building a site. For example, use a content adapter to create pages from a remote data source such as JSON, TOML, YAML, or XML. See [details](/content-management/content-adapters/).
|
||||
A template that dynamically creates pages when building a site. For example, use a content adapter to create pages from a remote data source such as JSON, TOML, YAML, or XML.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: content format
|
||||
reference: /content-management/formats
|
||||
---
|
||||
|
||||
A markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText. See [details](/content-management/formats/).
|
||||
A markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: content type
|
||||
reference: /content-management/types
|
||||
---
|
||||
|
||||
A classification of content inferred from the top-level directory name or the `type` set in [front matter](g). Pages in the root of the `content` directory, including the home page, are of type "page". Accessed via `.Page.Type` in [templates](g). See [details](/content-management/types/)
|
||||
A classification of content inferred from the top-level directory name or the `type` set in [front matter](g). Pages in the root of the `content` directory, including the home page, are of type "page". Accessed via `.Page.Type` in [templates](g).
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: content view
|
||||
reference: /templates/content-view
|
||||
---
|
||||
|
||||
A template called with the `.Page.Render` method. See [details](/templates/content-view/).
|
||||
A template called with the `.Page.Render` method.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: context
|
||||
reference: /templates/introduction/#context
|
||||
---
|
||||
|
||||
Represented by a dot "." within a [template action](g), context is the current location in a data structure. For example, while iterating over a [collection](g) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called. See [details](/templates/introduction/#context).
|
||||
Represented by a dot "." within a [template action](g), context is the current location in a data structure. For example, while iterating over a [collection](g) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: flag
|
||||
reference: /commands/hugo
|
||||
---
|
||||
|
||||
An option passed to a command-line program, beginning with one or two hyphens. See [details](/commands/hugo/).
|
||||
An option passed to a command-line program, beginning with one or two hyphens.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: front matter
|
||||
reference: /content-management/front-matter
|
||||
---
|
||||
|
||||
Metadata at the beginning of each content page, separated from the content by format-specific delimiters. See [details](/content-management/front-matter/).
|
||||
Metadata at the beginning of each content page, separated from the content by format-specific delimiters.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: function
|
||||
reference: /functions
|
||||
---
|
||||
|
||||
Used within a [template action](g), a function takes one or more [arguments](g) and returns a value. Unlike [methods](g), functions are not associated with an [object](g). See [details](/functions/).
|
||||
Used within a [template action](g), a function takes one or more [arguments](g) and returns a value. Unlike [methods](g), functions are not associated with an [object](g).
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: interpreted string literal
|
||||
---
|
||||
|
||||
Interpreted string literals are character sequences between double quotes, as in "foo". Within the quotes, any character may appear except a newline and an unescaped double quote. The text between the quotes forms the value of the literal, with backslash escapes interpreted. See [details](https://go.dev/ref/spec#String_literals).
|
||||
An _interpreted string literal_ is a character sequences between double quotes, as in "foo". Within the quotes, any character may appear except a newline and an unescaped double quote. The text between the quotes forms the value of the literal, with backslash escapes interpreted. See [details](https://go.dev/ref/spec#String_literals).
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: leaf bundle
|
||||
---
|
||||
|
||||
A directory that contains an index.md file and zero or more [resources](g). Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants. See [details](/content-management/page-bundles/).
|
||||
A directory that contains an `index.md` file and zero or more [resources](g). Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants. See [details](/content-management/page-bundles/).
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: pagination
|
||||
reference: /templates/pagination
|
||||
---
|
||||
|
||||
The process of [paginating](g) a list page. See [details](/templates/pagination/).
|
||||
The process of [paginating](g) a list page.
|
||||
|
@ -4,4 +4,4 @@ title: pipeline
|
||||
|
||||
Within a [template action](g), a pipeline is a possibly chained sequence of values, [function](g) calls, or [method](g) calls. Functions and methods in the pipeline may take multiple [arguments](g).
|
||||
|
||||
A pipeline may be *chained* by separating a sequence of commands with pipeline characters "|". In a chained pipeline, the result of each command is passed as the last argument to the following command. The output of the final command in the pipeline is the value of the pipeline. See the [Go documentation](https://pkg.go.dev/text/template#hdr-Pipelines) for details.
|
||||
A pipeline may be *chained* by separating a sequence of commands with pipeline characters "|". In a chained pipeline, the result of each command is passed as the last argument to the following command. The output of the final command in the pipeline is the value of the pipeline.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: raw string literal
|
||||
---
|
||||
|
||||
Raw string literals are character sequences between backticks, as in \`bar\`. Within the backticks, any character may appear except a backtick. Backslashes have no special meaning and the string may contain newlines. Carriage return characters (`\r`) inside raw string literals are discarded from the raw string value. See [details](https://go.dev/ref/spec#String_literals).
|
||||
A _raw string literal_ is a character sequences between backticks, as in \`bar\`. Within the backticks, any character may appear except a backtick. Backslashes have no special meaning and the string may contain newlines. Carriage return characters (`\r`) inside raw string literals are discarded from the raw string value.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: render hook
|
||||
reference: /render-hooks
|
||||
---
|
||||
|
||||
A [template](g) that overrides standard Markdown rendering. See [details](/render-hooks).
|
||||
A [template](g) that overrides standard Markdown rendering.
|
||||
|
@ -2,4 +2,4 @@
|
||||
title: section
|
||||
---
|
||||
|
||||
A section is a top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle](g). Section templates receive one or more page [collections](g) in [context](g). See [details](/content-management/sections/).
|
||||
A _section_ is a top-level content directory or any content directory containing an `_index.md` file. A section is also known as a [_branch bundle_](g).
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: shortcode
|
||||
reference: /content-management/shortcodes
|
||||
---
|
||||
|
||||
A [template](g) called from within Markdown, taking zero or more [arguments](g). See [details](/content-management/shortcodes/).
|
||||
A [template](g) called from within Markdown, taking zero or more [arguments](g).
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: taxonomic weight
|
||||
reference: content-management/taxonomies/#order-taxonomies
|
||||
---
|
||||
|
||||
Defined in front matter and unique to each taxonomy, this [weight](g) determines the sort order of page collections contained within a [`Taxonomy`](g) object. See [details](/content-management/taxonomies/#order-taxonomies).
|
||||
Defined in front matter and unique to each taxonomy, this [weight](g) determines the sort order of page collections contained within a [`Taxonomy`](g) object.
|
||||
|
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: taxonomy
|
||||
reference: /content-management/taxonomies
|
||||
---
|
||||
|
||||
A group of related [terms](g) used to classify content. For example, a "colors" taxonomy might include the terms "red", "green", and "blue". See [details](/content-management/taxonomies/).
|
||||
A group of related [terms](g) used to classify content. For example, a "colors" taxonomy might include the terms "red", "green", and "blue".
|
||||
|
@ -8,7 +8,7 @@ Feature|extended edition|extended/deploy edition
|
||||
:--|:-:|:-:
|
||||
Encode to the WebP format when [processing images]. You can decode WebP images with any edition.|:heavy_check_mark:|:heavy_check_mark:
|
||||
[Transpile Sass to CSS] using the embedded LibSass transpiler. You can use the [Dart Sass] transpiler with any edition.|:heavy_check_mark:|:heavy_check_mark:
|
||||
Deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container. See [details].|:x:|:heavy_check_mark:
|
||||
Deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container. See [details].|:x:|:heavy_check_mark:
|
||||
|
||||
[dart sass]: /functions/css/sass/#dart-sass
|
||||
[processing images]: /content-management/image-processing/
|
||||
|
@ -12,7 +12,7 @@ toc: true
|
||||
|
||||
By default, not all pages are backed by a file, including top level [section pages](g), [taxonomy pages](g), and [term pages](g). By definition, you cannot retrieve file information when the file does not exist.
|
||||
|
||||
To back one of the pages above with a file, create an `_index.md` file in the corresponding directory. For example:
|
||||
To back one of the pages above with a file, create an `_index.md` file in the corresponding directory. For example:
|
||||
|
||||
```text
|
||||
content/
|
||||
|
@ -70,7 +70,7 @@ When rendering lesson-2, the `Pages` method returns:
|
||||
lessons/lesson-2/resources/task-list.md
|
||||
lessons/lesson-2/resources/worksheet.md
|
||||
|
||||
In the last example, the collection includes pages in the resources subdirectory. That directory is not a [section](g)---it does not contain an `_index.md` file. Its contents are part of the lesson-2 section.
|
||||
In the last example, the collection includes pages in the resources subdirectory. That directory is not a [section](g)---it does not contain an `_index.md` file. Its contents are part of the lesson-2 section.
|
||||
|
||||
{{% note %}}
|
||||
When used with a `Site` object, the `Pages` method recursively returns all pages within the site. See [details].
|
||||
|
@ -67,7 +67,7 @@ When rendering lesson-2, the `RegularPages` method returns:
|
||||
lessons/lesson-2/resources/task-list.md
|
||||
lessons/lesson-2/resources/worksheet.md
|
||||
|
||||
In the last example, the collection includes pages in the resources subdirectory. That directory is not a [section](g)---it does not contain an _index.md file. Its contents are part of the lesson-2 section.
|
||||
In the last example, the collection includes pages in the resources subdirectory. That directory is not a [section](g)---it does not contain an `_index.md` file. Its contents are part of the lesson-2 section.
|
||||
|
||||
{{% note %}}
|
||||
When used with the `Site` object, the `RegularPages` method recursively returns all regular pages within the site. See [details].
|
||||
|
@ -15,7 +15,7 @@ Access to the `Sitemap` method on a `Page` object is restricted to [sitemap temp
|
||||
## Methods
|
||||
|
||||
changefreq
|
||||
: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
|
||||
: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
|
||||
|
||||
```go-html-template
|
||||
{{ .Sitemap.ChangeFreq }}
|
||||
@ -29,7 +29,7 @@ disable {{< new-in 0.125.0 >}}
|
||||
```
|
||||
|
||||
priority
|
||||
: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
|
||||
: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
|
||||
|
||||
```go-html-template
|
||||
{{ .Sitemap.Priority }}
|
||||
|
@ -33,7 +33,7 @@ You can change the capitalization style in your site configuration to one of `ap
|
||||
titleCaseStyle = "firstupper"
|
||||
{{< /code-toggle >}}
|
||||
|
||||
See [details].
|
||||
See [details].
|
||||
|
||||
[`capitalizeListTitles`]: /getting-started/configuration/#capitalizelisttitles
|
||||
[`pluralizeListTitles`]: /getting-started/configuration/#pluralizelisttitles
|
||||
|
@ -38,16 +38,16 @@ Your production server redirects the browser to the 404 page when a page is not
|
||||
|
||||
Host|Capabilities and configuration
|
||||
:--|:--
|
||||
Amazon CloudFront|See [details](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GeneratingCustomErrorResponses.html).
|
||||
Amazon S3|See [details](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CustomErrorDocSupport.html).
|
||||
Apache|See [details](https://httpd.apache.org/docs/2.4/custom-error.html).
|
||||
Azure Static Web Apps|See [details](https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#response-overrides).
|
||||
Azure Storage|See [details](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website#setting-up-a-static-website).
|
||||
Caddy|See [details](https://caddyserver.com/docs/caddyfile/directives/handle_errors).
|
||||
Cloudflare Pages|See [details](https://developers.cloudflare.com/pages/configuration/serving-pages/#not-found-behavior).
|
||||
DigitalOcean App Platform|See [details](https://docs.digitalocean.com/products/app-platform/how-to/manage-static-sites/#configure-a-static-site).
|
||||
Firebase|See [details](https://firebase.google.com/docs/hosting/full-config#404).
|
||||
Amazon CloudFront|See [details](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GeneratingCustomErrorResponses.html).
|
||||
Amazon S3|See [details](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CustomErrorDocSupport.html).
|
||||
Apache|See [details](https://httpd.apache.org/docs/2.4/custom-error.html).
|
||||
Azure Static Web Apps|See [details](https://learn.microsoft.com/en-us/azure/static-web-apps/configuration#response-overrides).
|
||||
Azure Storage|See [details](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-static-website#setting-up-a-static-website).
|
||||
Caddy|See [details](https://caddyserver.com/docs/caddyfile/directives/handle_errors).
|
||||
Cloudflare Pages|See [details](https://developers.cloudflare.com/pages/configuration/serving-pages/#not-found-behavior).
|
||||
DigitalOcean App Platform|See [details](https://docs.digitalocean.com/products/app-platform/how-to/manage-static-sites/#configure-a-static-site).
|
||||
Firebase|See [details](https://firebase.google.com/docs/hosting/full-config#404).
|
||||
GitHub Pages|Redirection to is automatic and not configurable.
|
||||
GitLab Pages|See [details](https://docs.gitlab.com/ee/user/project/pages/introduction.html#custom-error-codes-pages).
|
||||
NGINX|See [details](https://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
|
||||
Netlify|See [details](https://docs.netlify.com/routing/redirects/redirect-options/).
|
||||
GitLab Pages|See [details](https://docs.gitlab.com/ee/user/project/pages/introduction.html#custom-error-codes-pages).
|
||||
NGINX|See [details](https://nginx.org/en/docs/http/ngx_http_core_module.html#error_page).
|
||||
Netlify|See [details](https://docs.netlify.com/routing/redirects/redirect-options/).
|
||||
|
@ -22,7 +22,7 @@ See [Template Lookup](/templates/lookup-order/).
|
||||
|
||||
## Add content and front matter to the home page
|
||||
|
||||
The home page accepts content and front matter from an `_index.md` file. This file should live at the root of your `content` directory (i.e., `content/_index.md`). You can then add body copy and metadata to your home page the way you would any other content file.
|
||||
The home page accepts content and front matter from an `_index.md` file. This file should live at the root of your `content` directory (i.e., `content/_index.md`). You can then add body copy and metadata to your home page the way you would any other content file.
|
||||
|
||||
See the home template below or [Content Organization][contentorg] for more information on the role of `_index.md` in adding content and front matter to list pages.
|
||||
|
||||
|
@ -33,7 +33,7 @@ These are the default sitemap configuration values. They apply to all pages unle
|
||||
{{< code-toggle config=sitemap />}}
|
||||
|
||||
changefreq
|
||||
: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
|
||||
: (`string`) How frequently a page is likely to change. Valid values are `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, and `never`. With the default value of `""` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#changefreqdef).
|
||||
|
||||
disable {{< new-in 0.125.0 >}}
|
||||
: (`bool`) Whether to disable page inclusion. Default is `false`. Set to `true` in front matter to exclude the page.
|
||||
@ -42,7 +42,7 @@ filename
|
||||
: (`string`) The name of the generated file. Default is `sitemap.xml`.
|
||||
|
||||
priority
|
||||
: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
|
||||
: (`float`) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. With the default value of `-1` Hugo will omit this field from the sitemap. See [details](https://www.sitemaps.org/protocol.html#priority).
|
||||
|
||||
## Override default values
|
||||
|
||||
|
@ -51,11 +51,11 @@ If the answer to any of these questions is yes, either change the field values,
|
||||
|
||||
###### Why can't I see any of a page's descendants?
|
||||
|
||||
You may have an `index.md` file instead of an `_index.md` file. See [details](/content-management/page-bundles/).
|
||||
You may have an `index.md` file instead of an `_index.md` file. See [details](/content-management/page-bundles/).
|
||||
|
||||
###### What is the difference between an index.md file and an _index.md file?
|
||||
###### What is the difference between an `index.md` file and an `_index.md` file?
|
||||
|
||||
A directory with an `index.md file` is a [leaf bundle](g). A directory with an `_index.md` file is a [branch bundle](g). See [details](/content-management/page-bundles/).
|
||||
A directory with an `index.md file` is a [leaf bundle](g). A directory with an `_index.md` file is a [branch bundle](g). See [details](/content-management/page-bundles/).
|
||||
|
||||
###### Why is my partial template not rendered as expected?
|
||||
|
||||
|
@ -35,6 +35,11 @@ shortcode.
|
||||
{{- range $p }}
|
||||
###### {{ .Title }}{{/* Do not indent. */}}
|
||||
{{ .RenderShortcodes }}{{/* Do not indent. */}}
|
||||
{{- with .Params.reference }}
|
||||
{{- with site.GetPage . -}}
|
||||
 See [details]({{ .RelPermalink }}).{{/* Do not indent. */}}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
|
||||
{{- end }}
|
||||
|
Loading…
x
Reference in New Issue
Block a user