aboutsummaryrefslogtreecommitdiffhomepage
path: root/content/en/methods/page/IsHome.md
blob: b688f88c0e6f1479ed537d87c66c2a33f74b52d8 (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
---
title: IsHome
description: Reports whether the given page is the home page.
categories: []
keywords: []
action:
  related:
    - methods/page/IsNode
    - methods/page/IsPage
    - methods/page/IsSection
  returnType: bool
  signatures: [PAGE.IsHome]
---

The `IsHome` method on a `Page` object returns `true` if the [page kind] is `home`.

```text
content/
├── books/
│   ├── book-1/
│   │   └── index.md  <-- kind = page
│   ├── book-2.md     <-- kind = page
│   └── _index.md     <-- kind = section
└── _index.md         <-- kind = home
```

```go-html-template
{{ .IsHome }}
```

[page kind]: /getting-started/glossary/#page-kind