Children

Arrr! Pirrrates

Fello' pirrates, be awarrre some featurrres may not work fer us in this trrranslat'n. Like table of rrramblings, some Merrrmaids and stuff.

Th' children shorrrtcode lists th' child planks o' a plank an' its descendants .

Usage

While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shorrrtcode from yer own partials.

{{% children sort="weight" %}}

{{ partial "shortcodes/children.html" (dict
  "context" .
  "sort" "weight"
)}}

Name	Default	Notes
plank	<current>	Specify th' plank name (section name) t' display children fer.
containerstyle	`ul`	Choose th' style used t' group all children. It could be any HTML tag name.
style	`li`	Choose th' style used t' display each descendant. It could be any HTML tag name.
showhidden	`false`	When `true`, child planks hidden from th' menu will be displayed aswell.
descript'n	`false`	When `true` shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - read more info about summaries on gohugo.io.
depth	`1`	Th' depth o' descendants t' display. For example, if th' value be `2`, th' shorrrtcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. `999`.
sort	see notes	Th' sort order o' th' displayed list. If not set it be sorted by th' `ordersectionsby` sett'n o' th' ship an' th' planks frontmatter - `weight`: t' sort on menu order - `title`: t' sort alphabetically on menu label.

{{% children  %}}

{{% children descript'n="true" %}}

{{% children depth="999" showhidden="true" %}}

{{% children containerstyle="div" style="h2" depth="3" descript'n="true" %}}

{{% children containerstyle="div" style="div" depth="3" %}}