mirror of
https://github.com/gohugoio/hugo.git
synced 2024-07-08 01:56:15 +00:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
55 lines
1.3 KiB
Markdown
55 lines
1.3 KiB
Markdown
---
|
|
title: Section
|
|
description: Returns the name of the top level section in which the given page resides.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
related:
|
|
- methods/page/Type
|
|
returnType: string
|
|
signatures: [PAGE.Section]
|
|
---
|
|
|
|
With this content structure:
|
|
|
|
```text
|
|
content/
|
|
├── lessons/
|
|
│ ├── math/
|
|
│ │ ├── _index.md
|
|
│ │ ├── lesson-1.md
|
|
│ │ └── lesson-2.md
|
|
│ └── _index.md
|
|
└── _index.md
|
|
```
|
|
|
|
When rendering lesson-1.md:
|
|
|
|
```go-html-template
|
|
{{ .Section }} → lessons
|
|
```
|
|
|
|
In the example above "lessons" is the top level section.
|
|
|
|
The `Section` method is often used with the [`where`] function to build a page collection.
|
|
|
|
```go-html-template
|
|
{{ range where .Site.RegularPages "Section" "lessons" }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
```
|
|
|
|
This is similar to using the [`Type`] method with the `where` function
|
|
|
|
```go-html-template
|
|
{{ range where .Site.RegularPages "Type" "lessons" }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
{{ end }}
|
|
```
|
|
|
|
However, if the `type` field in front matter has been defined on one or more pages, the page collection based on `Type` will be different than the page collection based on `Section`.
|
|
|
|
|
|
[`where`]: /functions/collections/where
|
|
[`Type`]: /methods/page/type
|