diff --git a/404.html b/404.html index 4498d94eac..3138814096 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ - + @@ -20,18 +20,18 @@ 404 Page not found :: Hugo Relearn Theme - - - - - - - - - - - - + + + + + + + + + + + + - - - - - + + + + + + + + + + + + - + + + +
+
+ +
+
+
+
+
+
+ +

Tree

+ +

Th' tree shortcode displays a list as a tree wit' configur'ble ay'cons an' colors.

+ +
    +
  • home +
      +
    • .config
      • +
    • My Documents +
        +
      • home.php
        • +
      +
      • +
    +
    • +
+
+

Usage

+
+
+
​
+ + + +
+
+
+
+
```tree
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+```
+
+
+
+
+
{{% tree %}}
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+{{% /tree %}}
+
+
+
+
+
{{ partial "shortcodes/tree.html" (dict
+  "page" .
+  "content" `- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4`
+)}}
+
+
+
+
+

Codefence rules be widely avail'ble 'n other Marrrkdown parsers like GitHub an' therefore be th' recommend rules fer generat'n portable Marrrkdown.

+

Parameter

+ + + + + + + + + + + + + + + +
NameDefaultNotes
<content><empty>Yer list as Marrrkdown.
+

Item Rules

+

<TEXT> [ :: <ICON> [ :: <COLOR> ] ]

+

Text can be followed by optional do'ble colons (::) t' define an ay'con an' another optional do'ble colons t' define th' icon’s color.

+
    +
  • +

    ICON: Font Awesome ay'con name set t' th' left o' th' text. If ye give a single str'n, it be selected from Font Awesome’s solid ay'cons. If ye want t' use a different set, ye have t' give th' complete styles after th' do'ble colons. See above example fer th' home.php.

    +
    • +
  • +

    COLOR: Th' CSS color value t' be used. If not set, th' primary color will be used.

    +

    Ye can also set a style value known from other shorrrtcodes.

    +
      +
    • by severity: caut'n, important, info, note, tip, warning
      • +
    • by brand color: primary, secondary, accent
      • +
    • by color: blue, cyan, green, grey, magenta, orange, red
      • +
    • by special color: default, transparent, code
      • +
    • ye can also define yer own styles.
      • +
    +

    If a style an' a named HTML color have th' same name, th' HTML color will be used.

    +
    • +
+ + + +
+
+
+
+ + + + + + diff --git a/pir/shortcodes/tree/index.print.html b/pir/shortcodes/tree/index.print.html new file mode 100644 index 0000000000..a3afb16d11 --- /dev/null +++ b/pir/shortcodes/tree/index.print.html @@ -0,0 +1,340 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Tree :: Cap'n Hugo Relearrrn Theme + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+ +

Tree

+ +

Th' tree shortcode displays a list as a tree wit' configur'ble ay'cons an' colors.

+ +
    +
  • home +
      +
    • .config
      • +
    • My Documents +
        +
      • home.php
        • +
      +
      • +
    +
    • +
+
+

Usage

+
+
+
​
+ + + +
+
+
+
+
```tree
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+```
+
+
+
+
+
{{% tree %}}
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+{{% /tree %}}
+
+
+
+
+
{{ partial "shortcodes/tree.html" (dict
+  "page" .
+  "content" `- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4`
+)}}
+
+
+
+
+

Codefence rules be widely avail'ble 'n other Marrrkdown parsers like GitHub an' therefore be th' recommend rules fer generat'n portable Marrrkdown.

+

Parameter

+ + + + + + + + + + + + + + + +
NameDefaultNotes
<content><empty>Yer list as Marrrkdown.
+

Item Rules

+

<TEXT> [ :: <ICON> [ :: <COLOR> ] ]

+

Text can be followed by optional do'ble colons (::) t' define an ay'con an' another optional do'ble colons t' define th' icon’s color.

+
    +
  • +

    ICON: Font Awesome ay'con name set t' th' left o' th' text. If ye give a single str'n, it be selected from Font Awesome’s solid ay'cons. If ye want t' use a different set, ye have t' give th' complete styles after th' do'ble colons. See above example fer th' home.php.

    +
    • +
  • +

    COLOR: Th' CSS color value t' be used. If not set, th' primary color will be used.

    +

    Ye can also set a style value known from other shorrrtcodes.

    +
      +
    • by severity: caut'n, important, info, note, tip, warning
      • +
    • by brand color: primary, secondary, accent
      • +
    • by color: blue, cyan, green, grey, magenta, orange, red
      • +
    • by special color: default, transparent, code
      • +
    • ye can also define yer own styles.
      • +
    +

    If a style an' a named HTML color have th' same name, th' HTML color will be used.

    +
    • +
+ + + +
+
+
+
+ + + + + diff --git a/pir/shortcodes/tree/index.xml b/pir/shortcodes/tree/index.xml new file mode 100644 index 0000000000..ae570b888a --- /dev/null +++ b/pir/shortcodes/tree/index.xml @@ -0,0 +1,11 @@ + + + + Tree :: Cap'n Hugo Relearrrn Theme + https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/tree/index.html + Display a list as a tree + Hugo + art-x-pir + + + \ No newline at end of file diff --git a/pir/showcase/index.html b/pir/showcase/index.html index 36ed3710e7..a83ffed06e 100644 --- a/pir/showcase/index.html +++ b/pir/showcase/index.html @@ -4,7 +4,7 @@ - + @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - + + + +
+
+ +
+
+
+
+
+
+ +

Tree

+ +

The tree shortcode displays a list as a tree with configurable icons and colors.

+ +
    +
  • home +
      +
    • .config
      • +
    • My Documents +
        +
      • home.php
        • +
      +
      • +
    +
    • +
+
+

Usage

+
+
+
​
+ + + +
+
+
+
+
```tree
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+```
+
+
+
+
+
{{% tree %}}
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+{{% /tree %}}
+
+
+
+
+
{{ partial "shortcodes/tree.html" (dict
+  "page" .
+  "content" `- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4`
+)}}
+
+
+
+
+

Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.

+

Parameter

+ + + + + + + + + + + + + + + +
NameDefaultNotes
<content><empty>Your list as Markdown.
+

Item Syntax

+

<TEXT> [ :: <ICON> [ :: <COLOR> ] ]

+

Text can be followed by optional double colons (::) to define an icon and another optional double colons to define the icon’s color.

+
    +
  • +

    ICON: Font Awesome icon name set to the left of the text. If you give a single string, it is selected from Font Awesome’s solid icons. If you want to use a different set, you have to give the complete styles after the double colons. See above example for the home.php.

    +
    • +
  • +

    COLOR: The CSS color value to be used. If not set, the primary color will be used.

    +

    You can also set a style value known from other shortcodes.

    +
      +
    • by severity: caution, important, info, note, tip, warning
      • +
    • by brand color: primary, secondary, accent
      • +
    • by color: blue, cyan, green, grey, magenta, orange, red
      • +
    • by special color: default, transparent, code
      • +
    • you can also define your own styles.
      • +
    +

    If a style and a named HTML color have the same name, the HTML color will be used.

    +
    • +
+ + +
+
+
+
+ + + + + + diff --git a/shortcodes/tree/index.print.html b/shortcodes/tree/index.print.html new file mode 100644 index 0000000000..f0d30dbad4 --- /dev/null +++ b/shortcodes/tree/index.print.html @@ -0,0 +1,339 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Tree :: Hugo Relearn Theme + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+ +

Tree

+ +

The tree shortcode displays a list as a tree with configurable icons and colors.

+ +
    +
  • home +
      +
    • .config
      • +
    • My Documents +
        +
      • home.php
        • +
      +
      • +
    +
    • +
+
+

Usage

+
+
+
​
+ + + +
+
+
+
+
```tree
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+```
+
+
+
+
+
{{% tree %}}
+- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4
+{{% /tree %}}
+
+
+
+
+
{{ partial "shortcodes/tree.html" (dict
+  "page" .
+  "content" `- home::folder
+  - .config::folder
+  - My Documents::folder::magic
+    - home.php::fa-fw fab fa-php::#888cc4`
+)}}
+
+
+
+
+

Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.

+

Parameter

+ + + + + + + + + + + + + + + +
NameDefaultNotes
<content><empty>Your list as Markdown.
+

Item Syntax

+

<TEXT> [ :: <ICON> [ :: <COLOR> ] ]

+

Text can be followed by optional double colons (::) to define an icon and another optional double colons to define the icon’s color.

+
    +
  • +

    ICON: Font Awesome icon name set to the left of the text. If you give a single string, it is selected from Font Awesome’s solid icons. If you want to use a different set, you have to give the complete styles after the double colons. See above example for the home.php.

    +
    • +
  • +

    COLOR: The CSS color value to be used. If not set, the primary color will be used.

    +

    You can also set a style value known from other shortcodes.

    +
      +
    • by severity: caution, important, info, note, tip, warning
      • +
    • by brand color: primary, secondary, accent
      • +
    • by color: blue, cyan, green, grey, magenta, orange, red
      • +
    • by special color: default, transparent, code
      • +
    • you can also define your own styles.
      • +
    +

    If a style and a named HTML color have the same name, the HTML color will be used.

    +
    • +
+ + +
+
+
+
+ + + + + diff --git a/shortcodes/tree/index.xml b/shortcodes/tree/index.xml new file mode 100644 index 0000000000..ce949efa5f --- /dev/null +++ b/shortcodes/tree/index.xml @@ -0,0 +1,11 @@ + + + + Tree :: Hugo Relearn Theme + https://mcshelby.github.io/hugo-theme-relearn/shortcodes/tree/index.html + Display a list as a tree + Hugo + en + + + \ No newline at end of file diff --git a/showcase/index.html b/showcase/index.html index 990d7c7ae8..e2c86127f9 100644 --- a/showcase/index.html +++ b/showcase/index.html @@ -4,7 +4,7 @@ - + @@ -28,18 +28,18 @@ - - - - - - - - - - - - + + + + + + + + + + + + - +