blob: 251fe1a977c15bb0f7d3ce648602cf3e499af473 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
---
title: MainSections
description: Returns a slice of the main section names as defined in the site configuration, falling back to the top level section with the most pages.
categories: []
keywords: []
action:
related: []
returnType: '[]string'
signatures: [SITE.MainSections]
---
Site configuration:
{{< code-toggle file=hugo >}}
[params]
mainSections = ['books','films']
{{< /code-toggle >}}
Template:
```go-html-template
{{ .Site.MainSections }} → [books films]
```
If `params.mainSections` is not defined in the site configuration, this method returns a slice with one element---the top level section with the most pages.
With this content structure, the "films" section has the most pages:
```text
content/
├── books/
│ ├── book-1.md
│ └── book-2.md
├── films/
│ ├── film-1.md
│ ├── film-2.md
│ └── film-3.md
└── _index.md
```
Template:
```go-html-template
{{ .Site.MainSections }} → [films]
```
When creating a theme, instead of hardcoding section names when listing the most relevant pages on the front page, instruct site authors to set `params.mainSections` in their site configuration.
Then your home page template can do something like this:
```go-html-template
{{ range where .Site.RegularPages "Section" "in" .Site.MainSections }}
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
{{ end }}
```
|
