Skip to content

Latest commit

 

History

25 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

markdown-tree

Draw a tree of your project in markdown format, including links to the project's different folders and files

Documentation

usage: tree.py [-h] [-D DIRECTORY] [-f FILE] [-d MAX_DEPTH] [-e EXCLUDE] [-o ORDER] [-s] [-H] [-r] [-E] [-F] [-N NO_DEVELOP] [-q]

Markdown tree

options:
  -h, --help            show this help message and exit
  -D DIRECTORY, --directory DIRECTORY
                        Directory to display, default is current directory
  -f FILE, --file FILE  File to write the tree, default is stdout
  -d MAX_DEPTH, --max-depth MAX_DEPTH
                        Maximum depth of the tree, default is 5
  -e EXCLUDE, --exclude EXCLUDE
                        Exclude files matching the pattern
  -o ORDER, --order ORDER
                        Criteria for sorting, can be "default", "time" or "size", default is "default"
  -s, --separate        Separate files from directories
  -H, --show-hidden     Show hidden files
  -r, --reverse         Reverse the order of the files
  -E, --emotes          Use emotes
  -F, --display-from-directory
                        Display the tree from the directory (the directory you specified will be treated as ".")
  -N NO_DEVELOP, --no-develop NO_DEVELOP
                        Do not display the files in the directory matching the pattern, display "..." instead
  -q, --quick           Quick mode, add options "-d (maxint) -s -E -F" to the command

You can find here an example of output of this program.

About

CLI that renders your project tree as Markdown with clickable links to every file and folder.

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages