/Markdown-file-tree-builder

Simple python script that automatically builds a tree structure (with links) of your GitHub project.

Primary LanguagePython

Keep your project tidy!

Simple python script that automatically builds a tree structure (with links) of your GitHub project.

Usage

  1. Run:
        python3 markdown_file_tree.py --dir_path [path-to-folder] --project_name [project-name]

  1. Copy the results on your terminal/console to your readme.md

  2. Enjoy the tidiness:

📁 Markdown-file-tree-builder
   🗎 README.md
   🗎 markdown_file_tree.py

ARGS

The list of arguments is:

        --dir_path required, Directory to walk
        --ignore_path path to ignore name, can be a .gitignore file
        --project_name Name for the root, your repo name, default='root'

Note that it ignores automatically git files and hidden directory.

You can create your own ignore file where each row is the pathname or the name of the file to ignore.