Quick Start
Draw Folder Structure makes it incredibly easy to generate markdown representations of your project structure. Follow these simple steps to get started.Right-click on a Folder or File
In the file explorer, right-click on any folder or file you want to generate a structure for.
Select 'Generate Markdown structure'
From the context menu, click on “Generate Markdown structure”The extension will:
- Generate the markdown structure
- Automatically copy it to your clipboard
- Open a new document showing the generated structure
What Gets Generated
When you run the command, the extension creates a markdown-formatted text representation of your folder and file structure. The output is automatically wrapped in markdown code blocks for proper formatting.Example Output
For a typical VS Code extension project, the generated structure looks like this:Clipboard Integration
One of the most convenient features is the automatic clipboard integration:Every time you generate a structure, it’s automatically copied to your clipboard. No need to manually select and copy the text!
How It Works
- Automatic Copy: When the command completes, the markdown structure is written to your system clipboard
- Visual Confirmation: You’ll see a notification message confirming the copy
- Ready to Paste: Simply use
Cmd/Ctrl+Vto paste the structure anywhere
Usage Examples
- README Documentation
- GitHub Issues
- Pull Requests
Quick Tips
Keyboard Shortcut
While there’s no default keyboard shortcut, you can add one in VS Code:
- Open Keyboard Shortcuts (
Cmd/Ctrl+K Cmd/Ctrl+S) - Search for “Generate Markdown structure”
- Assign your preferred shortcut
Command Palette
You can also run the command from the Command Palette:
- Press
Cmd/Ctrl+Shift+P - Type “Generate Markdown structure”
- Press Enter
Multiple Structures
Need to document multiple folders?
- Generate each structure separately
- Each generation overwrites the clipboard
- Paste each one before generating the next
Large Folders
For folders with many files:
- Use exclusion patterns to filter unnecessary files
- Consider using .gitignore integration
- Disable recursion for shallow structures
Next Steps
Customize Styles
Explore 20+ different visual styles for your folder structures
Configure Settings
Learn about all available configuration options
Exclude Patterns
Set up patterns to exclude specific files and folders