initial commit

themes/hugo-theme-relearn/docs/content/shortcodes/children/_index.en.md

@@ -0,0 +1,87 @@
++++
+alwaysopen = false
+categories = ["howto", "reference"]
+frontmatter = ["ordersectionsby"]
+options = ["ordersectionsby"]
+description = "List the child pages of a page"
+title = "Children"
++++
+
+The `children` shortcode lists the child pages of the current page and its descendants.
+
+{{% children sort="title" %}}
+
+## Usage
+
+{{< tabs groupid="shortcode-parameter">}}
+{{% tab title="shortcode" %}}
+
+````go
+{{%/* children sort="title" */%}}
+````
+
+{{% /tab %}}
+{{% tab title="partial" %}}
+
+````go
+{{ partial "shortcodes/children.html" (dict
+  "page" .
+  "sort" "title"
+)}}
+````
+
+{{% /tab %}}
+{{< /tabs >}}
+
+### Parameter
+
+| Name               | Default           | Notes       |
+|--------------------|-------------------|-------------|
+| **containerstyle** | `ul`              | Choose the style used to group all children. It could be any HTML tag name. |
+| **style**          | `li`              | Choose the style used to display each descendant. It could be any HTML tag name. |
+| **showhidden**     | `false`           | When `true`, child pages hidden from the menu will be displayed as well. |
+| **description**    | `false`           | When `true` shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/). |
+| **depth**          | `1`               | The depth of descendants to display. For example, if the value is `2`, the shortcode will display two levels of child pages.  To get all descendants, set this value to a high  number eg. `999`. |
+| **sort**           | `auto`            | The sort criteria of the displayed list.<br><br>- `auto` defaults to `ordersectionsby` of the page's {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}}<br>&nbsp;&nbsp;&nbsp;&nbsp;or to `ordersectionsby` of the configuration {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}}<br>&nbsp;&nbsp;&nbsp;&nbsp;or to `weight`<br>- `weight`<br>- `title`<br>- `modifieddate`<br>- `expirydate`<br>- `publishdate`<br>- `date`<br>- `length`<br>- `default` adhering to Hugo's default sort criteria|
+
+## Examples
+
+### All Default
+
+````go
+{{%/* children */%}}
+````
+
+{{% children %}}
+
+### With Description
+
+````go
+{{%/* children description="true" */%}}
+````
+
+{{%children description="true" %}}
+
+### Infinite Depth and Hidden Pages
+
+````go
+{{%/* children depth="999" showhidden="true" */%}}
+````
+
+{{% children depth="999" showhidden="true" %}}
+
+### Heading Styles for Container and Elements
+
+````go
+{{%/* children containerstyle="div" style="h2" depth="3" description="true" */%}}
+````
+
+{{% children containerstyle="div" style="h2" depth="3" description="true" %}}
+
+### Divs for Group and Element Styles
+
+````go
+{{%/* children containerstyle="div" style="div" depth="3" */%}}
+````
+
+{{% children containerstyle="div" style="div" depth="3" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/_index.pir.md

@@ -0,0 +1,9 @@
++++
+alwaysopen = false
+categories = ["howto", "reference"]
+frontmatter = ["ordersectionsby"]
+options = ["ordersectionsby"]
+description = "List th' child planks on a plank"
+title = "Children"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/_index.en.md

@@ -0,0 +1,13 @@
++++
+alwaysopen = false
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 1"
+weight = 10
++++
+
+This is a demo child page.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/_index.pir.md

@@ -0,0 +1,8 @@
++++
+alwaysopen = false
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 1"
+weight = 10
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/_index.en.md

@@ -0,0 +1,12 @@
++++
+alwaysopen = true
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 1-1"
++++
+
+This is a demo child page with a hidden child. You can still access the hidden child [directly](shortcodes/children/children-1/children-1-1/children-1-1-1) or via the search.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/_index.pir.md

@@ -0,0 +1,7 @@
++++
+alwaysopen = true
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 1-1"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md

@@ -0,0 +1,12 @@
++++
+description = "This is a hidden demo child page"
+hidden = true
+tags = ["children", "the hidden"]
+title = "page 1-1-1 (hidden)"
++++
+
+This is a **hidden** demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren't viewing this page or its children directly.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.pir.md

@@ -0,0 +1,7 @@
++++
+description = "This be a hidden demo child plank"
+hidden = true
+tags = ["children", "the hidden"]
+title = "plank 1-1-1 (hidden)"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md

@@ -0,0 +1,11 @@
++++
+description = "This is a non-hidden demo child page of a hidden parent page"
+tags = ["children", "the hidden"]
+title = "page 1-1-1-1"
++++
+
+This is a **non-hidden** demo child page of a hidden parent page with a hidden child. You can still access the hidden child [directly](shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1) or via the search.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a non-hidden demo child plank o' a hidden parrrent plank"
+tags = ["children", "the hidden"]
+title = "plank 1-1-1-1"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md

@@ -0,0 +1,12 @@
++++
+description = "This is a hidden demo child page"
+hidden = true
+tags = ["children", "the hidden"]
+title = "page 1-1-1-1-1 (hidden)"
++++
+
+This is a **hidden** demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren't viewing this page or its children directly.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.pir.md

@@ -0,0 +1,7 @@
++++
+description = "This be a hidden demo child plank"
+hidden = true
+tags = ["children", "the hidden"]
+title = "plank 1-1-1-1-1 (hidden)"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/_index.en.md

@@ -0,0 +1,7 @@
++++
+description = "This is a non-hidden demo child page of a hidden parent page"
+tags = ["children", "the hidden"]
+title = "page 1-1-1-1-1-1"
++++
+
+This is a **non-hidden** demo child page of a hidden parent page.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/_index.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a non-hidden demo child plank on a hidden parrrent plank"
+tags = ["children", "the hidden"]
+title = "plank 1-1-1-1-1-1"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/_index.en.md

@@ -0,0 +1,15 @@
++++
+description = "This is a demo child page"
+tags = ["children", "headless", "non-hidden"]
+title = "page 1-1-2 (headless)"
+[_build]
+  render = "never"
++++
+
+This is a headless child page.
+
+While the heading is displayed in the theme for hierarchical views like the menu, the `children` shortcode, the chapter print feature and the breadcrumbs, its content will never be displayed and will not be accessible by search. Also its terms will not appear on the taxonomy pages.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/_index.pir.md

@@ -0,0 +1,8 @@
++++
+description = "This be a demo child plank"
+tags = ["children", "headless", "non-hidden"]
+title = "plank 1-1-2 (headless)"
+[_build]
+  render = "never"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/_index.en.md

@@ -0,0 +1,7 @@
++++
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 1-1-2-1"
++++
+
+This is a plain demo child page 1-1-2-1.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/_index.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 1-1-2-1"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/_index.en.md

@@ -0,0 +1,7 @@
++++
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 1-1-2-2"
++++
+
+This is a plain demo child page 1-1-2-2.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/_index.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 1-1-2-2"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-3/_index.en.md

@@ -0,0 +1,7 @@
++++
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 1-1-3"
++++
+
+This is a plain demo child page 1-1-3.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-1/children-1-1/children-1-1-3/_index.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 1-1-3"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-2/_index.en.md

@@ -0,0 +1,10 @@
++++
+alwaysopen = false
+tags = ["children", "non-hidden"]
+title = "page 2"
+weight = 20
++++
+
+This is a demo child page with no description.
+
+So its content is used as description.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-2/_index.pir.md

@@ -0,0 +1,7 @@
++++
+alwaysopen = false
+tags = ["children", "non-hidden"]
+title = "plank 2"
+weight = 20
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-3/_index.en.md

@@ -0,0 +1,13 @@
++++
+alwaysopen = false
+description = "This is a demo child page"
+tags = ["children", "non-hidden"]
+title = "page 3"
+weight = 30
++++
+
+This is a demo child page.
+
+## Subpages of this page
+
+{{% children showhidden="true" %}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-3/_index.pir.md

@@ -0,0 +1,8 @@
++++
+alwaysopen = false
+description = "This be a demo child plank"
+tags = ["children", "non-hidden"]
+title = "plank 3"
+weight = 30
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-3/test3.en.md

@@ -0,0 +1,7 @@
++++
+description = "This is a plain page test nested in a parent"
+tags = ["children", "non-hidden"]
+title = "page 3-1"
++++
+
+This is a plain demo child page 3-1.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-3/test3.pir.md

@@ -0,0 +1,6 @@
++++
+description = "This be a plain plank test nested 'n a parrrent"
+tags = ["children", "non-hidden"]
+title = "plank 3-1"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-4/_index.en.md

@@ -0,0 +1,10 @@
++++
+alwaysopen = false
+description = "This is a hidden demo child page"
+hidden = true
+tags = ["children", "the hidden"]
+title = "page 4 (hidden)"
+weight = 40
++++
+
+This is a **hidden** demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren't viewing this page or its children directly.

themes/hugo-theme-relearn/docs/content/shortcodes/children/children-4/_index.pir.md

@@ -0,0 +1,9 @@
++++
+alwaysopen = false
+description = "This be a hidden demo child plank"
+hidden = true
+tags = ["children", "the hidden"]
+title = "plank 4 (hidden)"
+weight = 40
++++
+{{< piratify >}}

themes/hugo-theme-relearn/docs/content/shortcodes/children/test.en.md

@@ -0,0 +1,10 @@
+---
+description: |
+  This is a plain page test, and the beginning of a YAML multiline description...
+tags:
+  - "Children"
+title: "page X"
+weight: 1
+---
+
+This is a plain demo child page X.

themes/hugo-theme-relearn/docs/content/shortcodes/children/test.pir.md

@@ -0,0 +1,9 @@
+---
+description: |
+  This be a plain plank test, an' th' beginn'n o' a YAML multiline description…
+tags:
+  - "Children"
+title: "plank X"
+weight: 1
+---
+{{< piratify >}}