README Directory Tree Builder｜Generate ASCII Tree Structures for Docs

This tool helps developers quickly generate clean, text-based directory tree diagrams for project README files and documentation. It saves you from the tedious process of manually creating and updating file structure representations.

💡 Tool Overview

• Dual Input Modes: Either paste an indented list of files and folders for quick generation or drag and drop an entire project folder for automatic scanning.
• Intelligent Parsing: Automatically detects indentation levels using either spaces or tabs to accurately reconstruct the folder hierarchy from plain text.
• Smart Folder Scanning: When using the folder drop feature, common development directories like .git, node_modules, .next, dist, and build are automatically excluded for a cleaner output.
• Comment Preservation: An option to keep or strip inline comments (lines starting with # or //) allows you to add annotations to your tree structure.
• Client-Side Processing: Your files and folder structures are processed entirely within your browser. No data is ever uploaded to a server, ensuring your code remains private and secure.

🧐 Frequently Asked Questions

Q. What directories are automatically excluded in Folder mode?

A. To provide a relevant and concise tree, the tool automatically ignores common development and system-generated directories. The standard exclusion list includes: .git, node_modules, .next, dist, build, coverage, .vscode, .idea, and .DS_Store.

Q. How does the text input parser handle different indentation styles?

A. The parser is designed to be flexible. It measures the indentation width of each line, whether it uses spaces or tabs (treating a tab as 4 spaces). It then determines the hierarchical levels based on the relative indentation, so you don't have to worry about strict space counts as long as the structure is consistent.

📚 Fun Facts about Directory Trees

The practice of representing directory structures as text-based trees, often called ASCII trees, originates from early command-line utilities. The tree command, available on Unix, Linux, and other operating systems, is a classic tool that produces a similar output. This format became a standard for developers to quickly communicate a project's layout in plain text environments like emails, source code comments, and, most famously, README files. This web tool provides a modern, graphical interface for a task traditionally handled by the command line, making it accessible and convenient for all developers.