hugo/content/en/methods/page/IsHome.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

31 lines
684 B
Markdown

---
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