doc theme

2017-09-08 19:13:41 -07:00
parent f2a9f8a938
commit cb861e72a9
300 changed files with 38823 additions and 0 deletions
@@ -0,0 +1,48 @@
+++
+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.<br/>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. {{%alert success%}}**Tips:** set 999 to get all descendants{{%/alert%}}|
+| sort | none | Sort Children By<br><li><strong>Weight</strong> - to sort on menu order</li><li><strong>Name</strong> - to sort alphabetically on menu label</li><li><strong>Identifier</strong> - to sort alphabetically on identifier set in frontmatter</li><li><strong>URL</strong> - URL</li> |
+
+
+
+## Demo
+
+	{{%/* children  */%}}
+
+{{%children %}}
+
+	{{%/* children description="true"   */%}}
+
+{{%children description="true"   %}}
+
+	{{%/* children depth="3" showhidden="true" */%}}
+
+{{% children depth="3" showhidden="true" %}}
+
+	{{%/* children style="h2" depth="3" description="true" */%}}
+
+{{% children style="h2" depth="3" description="true" %}}
+
+	{{%/* children style="div" depth="999" */%}}
+
+{{% children style="div" depth="999" %}}
+
+
+
+
+
+
@@ -0,0 +1,6 @@
+++
+title = "page 1"
+description = "This is a demo child page"
+++
+
+This is a demo child page
@@ -0,0 +1,6 @@
+++
+title = "page 1-1"
+description = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod"
+++
+
+This is a demo child page
@@ -0,0 +1,6 @@
+++
+title = "page 1-1-1"
+description = "This is a demo child page"
+++
+
+This is a demo child page
@@ -0,0 +1,6 @@
+++
+title = "page 1-1-1-1"
+description = "This is a demo child page"
+++
+
+This is a demo child page
@@ -0,0 +1,6 @@
+++
+title = "page 1-1-1-1-1"
+description = "This is a demo child page"
+++
+
+This is a demo child page
@@ -0,0 +1,11 @@
+++
+title = "page 2"
+description = ""
+++
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+	tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+	quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+	consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+	cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+	proident, sunt in culpa qui officia deserunt mollit anim id est laborum.	
@@ -0,0 +1,6 @@
+++
+title = "page test 3"
+description = "This is a page test"
+++
+
+This is a test 3 demo child page
@@ -0,0 +1,6 @@
+++
+title = "page 3"
+description = "This is a demo child page"
+++
+
+This is a demo child page
@@ -0,0 +1,7 @@
+++
+title = "page 4"
+description = "This is a demo child page"
+hidden=true
+++
+
+This is a demo child page, not displayed in the menu
@@ -0,0 +1,6 @@
+++
+title = "page test"
+description = "This is a page test"
+++
+
+This is a test demo child page