About DirDoc
DirDoc is a powerful Bash script that generates comprehensive Markdown documentation of directory structures and file contents. It's the perfect tool for creating project snapshots, facilitating code reviews, and automating documentation processes.
Quick Start
- Download the script:
curl -O https://raw.githubusercontent.com/cansakirt/DirDoc/main/dirdoc.sh
- Make it executable:
chmod +x dirdoc.sh
- Run it on a directory:
./dirdoc.sh /path/to/your/directory
- Find the generated markdown file in your current directory.
Features
- Generate Markdown files with directory contents
- Create visual tree-like representation of directory structures
- Exclude files based on patterns
- Limit depth of directory traversal
- Debug output for troubleshooting
- Parallel processing for improved performance
Usage
./dirdoc.sh [OPTIONS] <directory-path>For more detailed usage instructions, please refer to our GitHub README.
Download
You can download DirDoc from our GitHub repository.
View on GitHub