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

Name Default Notes
<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.