aboutsummaryrefslogtreecommitdiffhomepage
path: root/content/en/methods/pages/ByWeight.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/en/methods/pages/ByWeight.md')
-rw-r--r--content/en/methods/pages/ByWeight.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/content/en/methods/pages/ByWeight.md b/content/en/methods/pages/ByWeight.md
new file mode 100644
index 000000000..4eafee11f
--- /dev/null
+++ b/content/en/methods/pages/ByWeight.md
@@ -0,0 +1,28 @@
+---
+title: ByWeight
+description: Returns the given page collection sorted by weight in ascending order.
+categories: []
+keywords: []
+action:
+ related: []
+ returnType: page.Pages
+ signatures: [PAGES.ByWeight]
+---
+
+Assign a [weight] to a page using the `weight` field in front matter. The weight must be a non-zero integer. Lighter items float to the top, while heavier items sink to the bottom. Unweighted or zero-weighted pages are placed at the end of the collection.
+
+[weight]: /getting-started/glossary/#weight
+
+```go-html-template
+{{ range .Pages.ByWeight }}
+ <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+{{ end }}
+```
+
+To sort in descending order:
+
+```go-html-template
+{{ range .Pages.ByWeight.Reverse }}
+ <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
+{{ end }}
+```