mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 09:32:09 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
31 lines
684 B
Markdown
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
|