Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michalbe/md-file-tree
Generate markdown list of all the files in a directory. Now also with emoji 📂 📄
https://github.com/michalbe/md-file-tree
bash-script emoji javascript markdown node tree
Last synced: 4 days ago
JSON representation
Generate markdown list of all the files in a directory. Now also with emoji 📂 📄
- Host: GitHub
- URL: https://github.com/michalbe/md-file-tree
- Owner: michalbe
- License: mit
- Created: 2015-06-17T14:35:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-25T16:19:03.000Z (over 1 year ago)
- Last Synced: 2024-12-31T04:07:36.392Z (11 days ago)
- Topics: bash-script, emoji, javascript, markdown, node, tree
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/md-file-tree
- Size: 34.2 KB
- Stars: 171
- Watchers: 3
- Forks: 39
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - michalbe/md-file-tree - Generate markdown list of all the files in a directory. Now also with emoji 📂 📄 (JavaScript)
- awesome-list - michalbe/md-file-tree - Generate markdown list of all the files in a directory. Now also with emoji 📂 📄 (JavaScript)
README
# md-file-tree by [@michalbe](http://github.com/michalbe)
Generate markdown tree of all the files in a directory, recursively.
## How to use?
### Install the script
```bash
$ npm install md-file-tree -g
```
### Run the tree script in any directory
```bash
$ md-file-tree
```
### Enable emoji (📂 & 📄) with the command line switch
```bash
$ md-file-tree --emoji
$ md-file-tree -e
```
### Redirect the output to a file
```bash
$ md-file-tree > list.md
```
This generates the `list.md` file with:
```markdown
- __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)
```
## 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.