mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 19:23:12 +00:00
49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
---
|
|
title : Children
|
|
description : List the child pages of a page
|
|
---
|
|
|
|
Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages.
|
|
|
|
## Usage
|
|
|
|
| Parameter | Default | Description |
|
|
|:--|:--|:--|
|
|
| page | _current_ | Specify the page name (section name) to display children for |
|
|
| style | "li" | Choose the style used to display descendants. It could be any HTML tag name |
|
|
| showhidden | "false" | When true, child pages hidden from the menu will be displayed |
|
|
| description | "false" | Allows you to include a short text under each page in the list. When no description exists for the page, children shortcode takes the first 70 words of your content. [Read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/) |
|
|
| depth | 1 | Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. **Tips:** set 999 to get all descendants |
|
|
| sort | none | Sort children by **Weight** - to sort on menu order, **Name** - to sort alphabetically on menu label, **Identifier** - to sort alphabetically on identifier set in frontmatter, and **URL** - to sort by URL |
|
|
|
|
## Demo
|
|
|
|
````go
|
|
{{%/* children */%}}
|
|
````
|
|
|
|
{{% children %}}
|
|
|
|
````go
|
|
{{%/* children description="true" */%}}
|
|
````
|
|
|
|
{{%children description="true" %}}
|
|
|
|
````go
|
|
{{%/* children depth="3" showhidden="true" */%}}
|
|
````
|
|
|
|
{{% children depth="3" showhidden="true" %}}
|
|
|
|
````go
|
|
{{%/* children style="h2" depth="3" description="true" */%}}
|
|
````
|
|
|
|
{{% children style="h2" depth="3" description="true" %}}
|
|
|
|
````go
|
|
{{%/* children style="div" depth="999" */%}}
|
|
````
|
|
|
|
{{% children style="div" depth="999" %}}
|