Skip to content

Generate a table-of-contents in markdown for any directory down to file leaves

Notifications You must be signed in to change notification settings

yhuag/filetree-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

filetree-md v1.1.1

Output the file tree in markdown format for any repositories down to file leaves.

Installation

npm i -g filetree-md

Sample Use Case

In the command line

filetree <name_of_directory>

GIF DEMO

Output

A markdown file will be generated at current directory, with the following format:

# File Directory of .
- **.**
	- .gitignore
	- README.md
	- **bin**
		- demo-global.js
	- **lib**
		- index.js
	- **node_modules**
		- **directory-tree**
			- .npmignore
			- .travis.yml
			- README.md
			- **lib**
				- directory-tree.js
			- package.json
	- package-lock.json
	- package.json

Future Updates

  • Enable direct links [x]
  • Enable path ignorance
  • Enable customized format
  • Enable file type ignorance

Dependencies Version

  1. directory-tree: ^2.1.0

About

Generate a table-of-contents in markdown for any directory down to file leaves

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published