0.1.0 • Published 3 years ago

node-file-tree-md v0.1.0

Weekly downloads
-
License
-
Repository
github
Last release
3 years ago

node-file-tree-md

Generate markdown tree of all the files in a directory, recursively. 生成文件目录列表到Markdown文件中,可以设置过滤的文件后缀名

How to use?

Install the script

$ npm install node-file-tree-md

Run the tree script in any directory

$ md-file-tree

Enable emoji (📂 & 📄) with the command line switch

$ md-file-tree --emoji
$ md-file-tree -e

Redirect the output to a file

$ md-file-tree > list.md

This generates the list.md file with:

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

Redirect the output to a file with file prefix

$ md-file-tree > list.md -p html

This generates the list.md file with:

- __michal__
  - [test1](test1.html)
  - [test2](test2.html)

Hidden files & directories

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