dir-tree

The dir-tree generator creates a directory tree visualization for a given path.

Example

Input

<!-- automd:dir-tree src="./src" -->
<!-- /automd -->

Output

<!-- automd:dir-tree src="./src" -->

```
├── generators/
│   ├── badges.ts
│   ├── dir-tree.ts
│   └── ...
├── _utils.ts
├── automd.ts
└── index.ts
```

<!-- /automd -->

Arguments

src

string

Relative path to the directory. Defaults to ..

ignore

string

Comma-separated list of additional patterns to ignore (e.g., ignore="tests,*.config.ts").

maxDepth

number

Maximum depth to traverse. Use maxDepth=1 to show only the top level.

Default Ignores

The following are ignored by default:

node_modules
.git
.DS_Store
.nuxt
.output
.nitro
dist
coverage
.cache
.turbo

Additionally, patterns from .gitignore in the target directory are automatically respected.

contributors

fetch