Add page collection quick reference

This commit is contained in:
Joe Mooring 2023-11-19 12:56:31 -08:00 committed by GitHub
parent 699de883d1
commit 36f207f3a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 52 additions and 9 deletions

View File

@ -1,5 +1,5 @@
---
title: Quick reference
title: Quick reference guides
linkTitle: Overview
description: Quick reference guides to Hugo's features, functions, and methods.
categories: []

View File

@ -1,14 +1,13 @@
---
title: Emoji quick reference guide
linkTitle: Emojis
title: Emojis
description: Include emoji shortcodes in your markdown or templates.
categories: [quick reference]
keywords: [emoji]
menu:
docs:
parent: quick-reference
weight: 40
weight: 40
weight: 50
weight: 50
toc: true
---

View File

@ -1,6 +1,5 @@
---
title: Function quick reference guide
linkTitle: Functions
title: Functions
description: A quick reference guide to Hugo's functions, grouped by namespace. Aliases, if any, appear in parentheses to the right of the function name.
categories: [quick reference]
keywords: []

View File

@ -1,6 +1,5 @@
---
title: Method quick reference guide
linkTitle: Methods
title: Methods
description: A quick reference guide to Hugo's methods, grouped by object.
categories: [quick reference]
keywords: []

View File

@ -0,0 +1,46 @@
---
title: Page collections
description: A quick reference guide to Hugo's page collections.
categories: [quick reference]
keywords: []
menu:
docs:
parent: quick-reference
weight: 40
weight: 40
toc: true
---
## Page
Use these `Page` methods when rendering lists on [section] pages, [taxonomy] pages, [term] pages, and the home page.
[section]: /getting-started/glossary/#section
[taxonomy]: /getting-started/glossary/#taxonomy
[term]: /getting-started/glossary/#term
{{< list-pages-in-section path=/methods/page filter=methods_page_page_collections filterType=include omitElementIDs=true titlePrefix=PAGE. >}}
## Site
Use these `Site` methods when rendering lists on any page.
{{< list-pages-in-section path=/methods/site filter=methods_site_page_collections filterType=include omitElementIDs=true titlePrefix=SITE. >}}
## Filter
Use the [`where`] function to filter page collections.
[`where`]: /functions/collections/where
## Sort
Use these methods to sort page collections.
{{< list-pages-in-section path=/methods/pages filter=methods_pages_sort filterType=include titlePrefix=. omitElementIDs=true titlePrefix=PAGES. >}}
## Group
Use these methods to group page collections.
{{< list-pages-in-section path=/methods/pages filter=methods_pages_group filterType=include titlePrefix=. omitElementIDs=true titlePrefix=PAGES. >}}