hextra_mirror/exampleSite/content/docs/guide/shortcodes/filetree.md

---
title: FileTree Component
linkTitle: FileTree
---

## Example

{{< filetree/container >}}
  {{< filetree/folder name="content" >}}
    {{< filetree/file name="_index.md" >}}
    {{< filetree/folder name="docs" state="closed" >}}
      {{< filetree/file name="_index.md" >}}
      {{< filetree/file name="introduction.md" >}}
      {{< filetree/file name="introduction.fr.md" >}}
    {{< /filetree/folder >}}
  {{< /filetree/folder >}}
  {{< filetree/file name="hugo.toml" >}}
{{< /filetree/container >}}

## Usage

```text {filename="Markdown"}
{{</* filetree/container */>}}
  {{</* filetree/folder name="content" */>}}
    {{</* filetree/file name="_index.md" */>}}
    {{</* filetree/folder name="docs" state="closed" */>}}
      {{</* filetree/file name="_index.md" */>}}
      {{</* filetree/file name="introduction.md" */>}}
      {{</* filetree/file name="introduction.fr.md" */>}}
    {{</* /filetree/folder */>}}
  {{</* /filetree/folder */>}}
  {{</* filetree/file name="hugo.toml" */>}}
{{</* /filetree/container */>}}
```

## Options

### `filetree/file`

| Parameter | Description                                                          |
|-----------|----------------------------------------------------------------------|
| `name`    | The name of the file.                                                |

### `filetree/folder`

| Parameter | Description                                                          |
|-----------|----------------------------------------------------------------------|
| `name`    | The name of the file.                                                |
| `state`   | The state of the file. Can be `open` or `closed`. Default is `open`. |