73a01565c Remove comment shortcode documentation 0ca7ccd30 Replace usage of comment shortcode with HTML comments fe10d9899 Remove expired new-in labels 11e89dfcb [editorial] Link to proper render-hook page in relref.md 11a581c2f netlify: Hugo 0.142.0 1a4fcf7f7 Miscellaneous edits 2c7a3165f Markdown linting and cleanup 69d7a781b Replace links to glossary terms with custom render hook syntax 441752d2d Refactor glossary lookup portion of link render hook 80109a14f Fix glossary term linking for plural form cd95f0f34 Update link render hook to support glossary links 53eadb430 Remove the glossary template 1d40a7f3b Improve transform.ToMath examples 586970df2 Misc edits 6a06a8de7 Add glossary link shortcode 4171c0eb7 Improve description of masking with non-transparent images 41c8feb64 Fix example of image.Mask filter 704a81656 Add alignx option to images.Text usage example 7c03eb0cc Clarify context in example of using the try statement 56d9c9b71 Refactor glossary of terms 042a6846b Add expiry dates to deprecated methods pages 365ab345f Remove services key from instagram shortcode page b7fe31e07 Reorder options list for images.Text filter 8051ff818 Format directory names, file names, and file paths as code d09a14623 Update version refs for Hugo and Dart Sass 3bb006974 Add NODE_VERSION to Netlify config examples 3a0f2531e Fix typo 7e3198eaf Fix typo cf56452a3 Fix typo a9f51d13e Fix typo 82bfdd8c3 Fix typo a5c41a053 Fix typo abcfed7a5 Fix typo 8c1debf3a Remove outdated new-in badges 809ddf9ef Update theme 63867d56f Use warnf instead of errorf in try-catch example dee3e5f09 Update theme 9791f7057 Remove TODO from comment shortcode examples a346ca1fd Elevate embedded shortcode documentation to its own section 8fa19b50f hugoreleaser.toml => hugoreleaser.yaml 575d60345 Update docs for v0.141.0 a0a442d62 netlify: Hugo 0.141.0 6667cbcd8 Merge commit '81a7b6390036138356773c87a886679c81c524e1' f36fc013e docs: Regen CLI docs 365a47ded tpl/images: Change signature of images.QR to images.QR TEXT OPTIONS ae8f8af0a images.Text: Add "alignx" option for horizontal alignment 8f45ccca6 docs: Regen CLI docs f0e6304f4 Merge commit 'e9fbadacc3f09191e2e19f112a49777eeb8df06c' cb9bec2b2 tpl/images: Add images.QR function git-subtree-dir: docs git-subtree-split: 73a01565c5ba0774d65aa6f2384c44804fefa37d
5.8 KiB
title | description | categories | keywords | menu | weight | toc | aliases | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sections | Organize content into sections. |
|
|
|
120 | true |
|
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. Section templates receive one or more page collections in context.
{{% note %}}
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:
content/
├── articles/ <-- section (top-level directory)
│ ├── 2022/
│ │ ├── article-1/
│ │ │ ├── cover.jpg
│ │ │ └── index.md
│ │ └── article-2.md
│ └── 2023/
│ ├── article-3.md
│ └── article-4.md
├── products/ <-- section (top-level directory)
│ ├── product-1/ <-- section (has _index.md file)
│ │ ├── benefits/ <-- section (has _index.md file)
│ │ │ ├── _index.md
│ │ │ ├── benefit-1.md
│ │ │ └── benefit-2.md
│ │ ├── features/ <-- section (has _index.md file)
│ │ │ ├── _index.md
│ │ │ ├── feature-1.md
│ │ │ └── feature-2.md
│ │ └── _index.md
│ └── product-2/ <-- section (has _index.md file)
│ ├── benefits/ <-- section (has _index.md file)
│ │ ├── _index.md
│ │ ├── benefit-1.md
│ │ └── benefit-2.md
│ ├── features/ <-- section (has _index.md file)
│ │ ├── _index.md
│ │ ├── feature-1.md
│ │ └── feature-2.md
│ └── _index.md
├── _index.md
└── about.md
The example above has two top-level sections: articles and products. None of the directories under articles are sections, while all of the directories under products are sections. A section within a section is a known as a nested section or subsection.
Explanation
Sections and non-sections behave differently.
Sections | Non-sections | |
---|---|---|
Directory names become URL segments | ✔️ | ✔️ |
Have logical ancestors and descendants | ✔️ | ❌ |
Have list pages | ✔️ | ❌ |
With the file structure from the example above:
-
The list page for the articles section includes all articles, regardless of directory structure; none of the subdirectories are sections.
-
The articles/2022 and articles/2023 directories do not have list pages; they are not sections.
-
The list page for the products section, by default, includes product-1 and product-2, but not their descendant pages. To include descendant pages, use the
RegularPagesRecursive
method instead of thePages
method in the list template.
- All directories in the products section have list pages; each directory is a section.
Template selection
Hugo has a defined lookup order to determine which template to use when rendering a page. The lookup rules consider the top-level section name; subsection names are not considered when selecting a template.
With the file structure from the example above:
Content directory | Section template |
---|---|
content/products |
layouts/products/list.html |
content/products/product-1 |
layouts/products/list.html |
content/products/product-1/benefits |
layouts/products/list.html |
Content directory | Single template |
---|---|
content/products |
layouts/products/single.html |
content/products/product-1 |
layouts/products/single.html |
content/products/product-1/benefits |
layouts/products/single.html |
If you need to use a different template for a subsection, specify type
and/or layout
in front matter.
Ancestors and descendants
A section has one or more ancestors (including the home page), and zero or more descendants. With the file structure from the example above:
content/products/product-1/benefits/benefit-1.md
The content file (benefit-1.md) has four ancestors: benefits, product-1, products, and the home page. This logical relationship allows us to use the .Parent
and .Ancestors
methods to traverse the site structure.
For example, use the .Ancestors
method to render breadcrumb navigation.
{{< code file=layouts/partials/breadcrumb.html >}}
-
{{ range .Ancestors.Reverse }}
- {{ .LinkTitle }} {{ end }}
- {{ .LinkTitle }}
With this CSS:
.breadcrumb ol {
padding-left: 0;
}
.breadcrumb li {
display: inline;
}
.breadcrumb li:not(:last-child)::after {
content: "»";
}
Hugo renders this, where each breadcrumb is a link to the corresponding page:
Home » Products » Product 1 » Benefits » Benefit 1