Skip to content

mtsolakiszen/md-file-tree

 
 

Repository files navigation

md-file-tree by @michalbe

Generate markdown list of all the files in a directory.

How to use?

Install with:

 $ npm install md-file-tree -g

Then in any dir

$ md-file-tree > list.md

generated list.md file:

- __michal__
  - [.fancom](michal/.fancom)
  - [.git](michal/.git)
  - [.gitignore](michal/.gitignore)
  - [.jshintignore](michal/.jshintignore)
  - [.jshintrc](michal/.jshintrc)
  - [LICENSE](michal/LICENSE)
  - [README.md](michal/README.md)
  - __bin__
    - [cli.js](michal/bin/cli.js)
  - [michal.png](michal/michal.png)
  - [node_modules](michal/node_modules)
  - [npm-debug.log](michal/npm-debug.log)
  - [package.json](michal/package.json)
  - [screen.png](michal/screen.png)
  - __scripts__
    - [assert.js](michal/scripts/assert.js)
    - [fancom.js](michal/scripts/fancom.js)
    - [jshintrc.js](michal/scripts/jshintrc.js)
    - [package-json.js](michal/scripts/package-json.js)
    - [precommit-hook.js](michal/scripts/precommit-hook.js)
    - [scripts.js](michal/scripts/scripts.js)
    - [tests.js](michal/scripts/tests.js)
  - __tests__
    - [michal-tests.js](michal/tests/michal-tests.js)

note that this script skips all hidden files and directories (with ., like .git or .gitignore) & node_modules directory.

About

Generate markdown list of all the files in a directory.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%