summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/page/Sections.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/page/Sections.md')
-rw-r--r--docs/content/en/methods/page/Sections.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/content/en/methods/page/Sections.md b/docs/content/en/methods/page/Sections.md
new file mode 100644
index 000000000..d64440038
--- /dev/null
+++ b/docs/content/en/methods/page/Sections.md
@@ -0,0 +1,69 @@
+---
+title: Sections
+description: Returns a collection of section pages, one for each immediate descendant section of the given page.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/page/Ancestors
+ - methods/page/CurrentSection
+ - methods/page/FirstSection
+ - methods/page/InSection
+ - methods/page/IsAncestor
+ - methods/page/IsDescendant
+ - methods/page/Parent
+ returnType: page.Pages
+ signatures: [PAGE.Sections]
+---
+
+{{% include "methods/page/_common/definition-of-section.md" %}}
+
+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 = 10
+│ ├── book-1.md
+│ └── book-2.md
+├── films/
+│ ├── _index.md <-- front matter: weight = 20
+│ ├── 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>
+```