blob: b3ae4c04a13f4174e1a90e1724bffc02a950c710 (
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
56
|
---
title: FirstSection
description: Returns the Page object of the top level section of which the given page is a descendant.
categories: []
keywords: []
action:
related:
- methods/page/Ancestors
- methods/page/CurrentSection
- methods/page/InSection
- methods/page/IsAncestor
- methods/page/IsDescendant
- methods/page/Parent
- methods/page/Sections
returnType: page.Page
signatures: [PAGE.FirstSection]
---
{{% include "methods/page/_common/definition-of-section.md" %}}
{{% note %}}
When called on the home page, the `FirstSection` method returns the `Page` object of the home page itself.
{{% /note %}}
Consider this content structure:
```text
content/
├── auctions/
│ ├── 2023-11/
│ │ ├── _index.md <-- first section: auctions
│ │ ├── auction-1.md
│ │ └── auction-2.md <-- first section: auctions
│ ├── 2023-12/
│ │ ├── _index.md
│ │ ├── auction-3.md
│ │ └── auction-4.md
│ ├── _index.md <-- first section: auctions
│ ├── bidding.md
│ └── payment.md <-- first section: auctions
├── books/
│ ├── _index.md <-- first section: books
│ ├── book-1.md
│ └── book-2.md <-- first section: books
├── films/
│ ├── _index.md <-- first section: films
│ ├── film-1.md
│ └── film-2.md <-- first section: films
└── _index.md <-- first section: home
```
To link to the top level section of which the current page is a descendant:
```go-html-template
<a href="{{ .FirstSection.RelPermalink }}">{{ .FirstSection.LinkTitle }}</a>
```
|
