Skip to content

02. Application Overview

Jump to bottom
Ralph Maamari edited this page Jun 11, 2020 · 1 revision

This repository allows you to auto-generate hyperlink and markdown accessible project structures that you can copy into your README for a better developer experience!

How to Use

Web Application

  1. Paste Github URL of Repository
  2. Edit the tree by deleting what you don't need / editing file comments
  3. Click Copy Tree

Terminal (Command Line) (UnSupported)

Features Supported

  • Ability to generate HyperLinks inside a Markdown Accessible Code Block
  • Comments
    • Ability to Auto-Generate Comments for Common Files
    • Ability to Align all Comments within a specific Depth Level
    • Ability to Edit Auto-Generated Comments for Files
  • Deletion & Undo
    • Ability to delete specific files or entire folders if you don't want them included in your README
    • Ability to Undo a batch change of deletions in case a mistake was made
  • Ability to provide Custom Icons depending on the FileType
  • Ability to accordion view compress and uncompress folder structures (Just on the application not on the README)
Clone this wiki locally