mirror of https://github.com/gohugoio/hugo
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
---
|
|
title: Sections
|
|
description: Returns a collection of section pages, one for each immediate descendant section of the given page.
|
|
categories: []
|
|
keywords: []
|
|
params:
|
|
functions_and_methods:
|
|
returnType: page.Pages
|
|
signatures: [PAGE.Sections]
|
|
---
|
|
|
|
The `Sections` method on a `Page` object is available to these [page kinds](g): `home`, `section`, and `taxonomy`. The templates for these page kinds receive a page [collection](g) in [context](g), in the [default sort order](g).
|
|
|
|
With this content structure:
|
|
|
|
```text
|
|
content/
|
|
├── auctions/
|
|
│ ├── 2023-11/
|
|
│ │ ├── _index.md <-- front matter: weight = 202311
|
|
│ │ ├── auction-1.md
|
|
│ │ └── auction-2.md
|
|
│ ├── 2023-12/
|
|
│ │ ├── _index.md <-- front matter: weight = 202312
|
|
│ │ ├── auction-3.md
|
|
│ │ └── auction-4.md
|
|
│ ├── _index.md <-- front matter: weight = 30
|
|
│ ├── bidding.md
|
|
│ └── payment.md
|
|
├── books/
|
|
│ ├── _index.md <-- front matter: weight = 20
|
|
│ ├── book-1.md
|
|
│ └── book-2.md
|
|
├── films/
|
|
│ ├── _index.md <-- front matter: weight = 10
|
|
│ ├── film-1.md
|
|
│ └── film-2.md
|
|
└── _index.md
|
|
```
|
|
|
|
And this template:
|
|
|
|
```go-html-template
|
|
{{ range .Sections.ByWeight }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
```
|
|
|
|
On the home page, Hugo renders:
|
|
|
|
```html
|
|
<h2><a href="/films/">Films</a></h2>
|
|
<h2><a href="/books/">Books</a></h2>
|
|
<h2><a href="/auctions/">Auctions</a></h2>
|
|
```
|
|
|
|
On the auctions page, Hugo renders:
|
|
|
|
```html
|
|
<h2><a href="/auctions/2023-11/">Auctions in November 2023</a></h2>
|
|
<h2><a href="/auctions/2023-12/">Auctions in December 2023</a></h2>
|
|
```
|