Folder Structure Generators is a VS Code extension that creates a readable folder tree for your workspace and adds it to your README.md.

What It Does

Install

Install from the Visual Studio Marketplace:

You can also install the packaged .vsix file directly in VS Code:

Open your project folder in VS Code.
Open the Command Palette: macOS: Shift + Cmd + P Windows/Linux: Shift + Ctrl + P
Run one of these commands: Folder Structure Generator: Update README Structure Folder Structure Generator: Copy Folder Structure

Folder Structure Generator: Update README Structure Generates the workspace tree and inserts it into README.md.
Folder Structure Generator: Copy Folder Structure Generates the workspace tree and copies it to your clipboard.

my-project/
├── src/
│   ├── commands/
│   └── utils/
├── README.md
└── package.json

When you run Update README Structure, the extension adds or updates a section like this:

## Project Structure

```text
my-project/
├── src/
│   ├── commands/
│   └── utils/
├── README.md
└── package.json
```

You can configure these settings in VS Code:

folderStructureGenerator.sectionTitle The heading used in README.md. Default: Project Structure
folderStructureGenerator.maxDepth Maximum folder depth to include. Default: 3
folderStructureGenerator.includeFiles Include files in the generated output. Default: true
folderStructureGenerator.exclude Files and folders to ignore

The extension also respects entries from the workspace .gitignore file.

Default excluded names:

[
  ".git",
  "node_modules",
  "folder-structure-generator",
  ".DS_Store",
  ".vscode-test",
  "dist",
  "out"
]

VS Code 1.85.0 or later
A workspace folder with a README.md file if you want to update documentation automatically

MIT