aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/site/Sections.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/site/Sections.md')
-rw-r--r--docs/content/en/methods/site/Sections.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/content/en/methods/site/Sections.md b/docs/content/en/methods/site/Sections.md
new file mode 100644
index 000000000..a397c5926
--- /dev/null
+++ b/docs/content/en/methods/site/Sections.md
@@ -0,0 +1,41 @@
+---
+title: Sections
+description: Returns a collection of first level section pages.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/site/AllPages
+ - methods/site/Pages
+ - methods/site/RegularPages
+ returnType: page.Pages
+ signatures: [SITE.Sections]
+---
+
+Given this content structure:
+
+```text
+content/
+├── books/
+│ ├── book-1.md
+│ └── book-2.md
+├── films/
+│ ├── film-1.md
+│ └── film-2.md
+└── _index.md
+```
+
+This template:
+
+```go-html-template
+{{ range .Site.Sections }}
+ <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+{{ end }}
+```
+
+Is rendered to:
+
+```html
+<h2><a href="/books/">Books</a></h2>
+<h2><a href="/films/">Films</a></h2>
+```