Skip to content

A tool that generates a clean ASCII representation of a GitHub repository structure, perfect for documentation and sharing.

License

Notifications You must be signed in to change notification settings

coder-ralph/RepoTree

Repository files navigation

RepoTree

A simple tool to visualize GitHub repositories. It helps developers easily explore and understand their project structures.

Features

  • Clean ASCII view of GitHub repository structure.
  • Interactive tree view for easy navigation.
  • Download options in various formats.
  • Real-time search to find files or folders quickly.
  • Dark and Light themes for better readability.
  • Easy to use and no installation required.

Usage

  1. Visit RepoTree.
  2. Enter the GitHub repository URL.
  3. Click on the Generate button.
  4. Explore the repository structure.
  5. Download the tree in various formats.

Download Options

  • README: Download the tree in README format.
  • Text: Download the tree in text format.
  • JSON: Download the tree in JSON format.
  • HTML: Download the tree in HTML format.

Development

  1. Clone the repository:
git clone
  1. Install the dependencies:
npm install
  1. Run the development server:
npm run dev
  1. Open http://localhost:3000 in your browser.

Contributing

Contributions are welcome! Report issues here or submit a pull request here.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

This project was inspired by Nathan Friend's Tree Online and ASCII Tree Generator.

Support

⭐ If you find this project helpful, give it a star!

About

A tool that generates a clean ASCII representation of a GitHub repository structure, perfect for documentation and sharing.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published