File tree

Preview#

  • content-brand/brand documentation
    • docs/
      • _index.en.mddocumentation home
  • hugo.ymlsite configuration

Example

filetree/container

{{< filetree/container >}}

filetree/folder

{{< filetree/folder name="config" >}}

filetree/file

{{< filetree/file name="site.yml" >}}

When to use

filetree/container — Wrapper for a file tree; holds `filetree/folder` and `filetree/file` entries.

filetree/folder — A folder entry inside a `filetree/container`.

filetree/file — A file entry inside a `filetree/container`.

Implementation

layouts/shortcodes/filetree/container.html
layouts/shortcodes/filetree/folder.html
layouts/shortcodes/filetree/file.html

Options

filetree/container

This shortcode has no named parameters in its template.

filetree/folder

OptionRead by the shortcode template
nameRead by the shortcode template
annotationRead by the shortcode template
openRead by the shortcode template

filetree/file

OptionRead by the shortcode template
nameRead by the shortcode template
annotationRead by the shortcode template

Interface manifest

Kind
Shortcode
Category
Content
Status
Implemented
Implementation
Shortcode:layouts/shortcodes/filetree/container.htmllayouts/shortcodes/filetree/folder.htmllayouts/shortcodes/filetree/file.html