Skip to content

JawadAlhindi/folder-structure-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Folder Structure Generator

A Python utility that generates a visual folder structure tree in Markdown format for documentation purposes.

Installation

pip install -r requirements.txt

Usage

Run the script in any directory to generate a folder structure:

python main.py

This creates a folder_structure.md file with a tree view of the current directory.

Building Executable

Create a standalone executable:

python build.py

Or on Windows:

build.bat

The executable will be created in the dist/ folder.

Features

  • Automatically excludes common build artifacts (node_modules, .git, dist, etc.)
  • Generates clean Markdown output
  • Cross-platform support
  • Can be built into a standalone executable

Output Example

# Folder Structure

**Base Directory:** `/path/to/project`  
**Generated On:** 2023-10-07 06:30:00 AM

project/ ├── src/ │ ├── components/ │ └── utils/ ├── tests/ └── README.md