Initial Commit

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

@@ -0,0 +1,51 @@
++++
+alwaysopen = false
+description = "List the child pages of a page"
+title = "Children"
++++
+
+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 |
+| 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 |
+| 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 | [ordersectionsby]({{% relref "basics/configuration#global-site-parameters" %}}) | Sort children by **weight**, to sort on menu order - **title**, to sort alphabetically on menu label. If not set it is sorted by the `ordersectionsby` setting of the site and the pages frontmatter |
+
+## Demo
+
+````go
+{{%/* children  */%}}
+````
+
+{{% children %}}
+
+````go
+{{%/* children description="true" */%}}
+````
+
+{{%children description="true" %}}
+
+````go
+{{%/* children depth="999" showhidden="true" */%}}
+````
+
+{{% children depth="999" showhidden="true" %}}
+
+````go
+{{%/* children containerstyle="div" style="h2" depth="3" description="true" */%}}
+````
+
+{{% children containerstyle="div" style="h2" depth="3" description="true" %}}
+
+````go
+{{%/* children containerstyle="div" style="div" depth="999" */%}}
+````
+
+{{% children containerstyle="div" style="div" depth="999" %}}

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

@@ -0,0 +1,6 @@
++++
+alwaysopen = false
+descrption = "List th' child planks on a plank"
+title = "Children"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/exampleSite/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/exampleSite/content/shortcodes/children/children-1/_index.pir.md

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

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

@@ -0,0 +1,12 @@
++++
+alwaysopen = false
+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]({{% relref "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/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.pir.md

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

themes/hugo-theme-relearn/exampleSite/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", "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/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.pir.md

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

themes/hugo-theme-relearn/exampleSite/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", "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]({{% relref "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/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.pir.md

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

themes/hugo-theme-relearn/exampleSite/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", "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/exampleSite/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 @@
++++
+descrption = "This be a hidden demo child plank"
+hidden = true
+tags = ["children", "hidden"]
+title = "Plank 1-1-1-1-1 (hidden)"
++++
+{{< piratify >}}

themes/hugo-theme-relearn/exampleSite/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", "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/exampleSite/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 @@
++++
+descrption = "This be a non-hidden demo child plank on a hidden parrrent plank"
+tags = ["children", "hidden"]
+title = "Plank 1-1-1-1-1-1"
++++
+{{< piratify >}}

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

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

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

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

themes/hugo-theme-relearn/exampleSite/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.

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

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

themes/hugo-theme-relearn/exampleSite/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.

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

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

themes/hugo-theme-relearn/exampleSite/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.

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

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

themes/hugo-theme-relearn/exampleSite/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/exampleSite/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/exampleSite/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/exampleSite/content/shortcodes/children/children-3/_index.pir.md

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

themes/hugo-theme-relearn/exampleSite/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.

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

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

themes/hugo-theme-relearn/exampleSite/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", "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/exampleSite/content/shortcodes/children/children-4/_index.pir.md

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

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

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

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

@@ -0,0 +1,6 @@
++++
+descrption = "This be a plain plank test"
+title = "Plank X"
+weight = 1
++++
+{{< piratify >}}