# node-file-tree-md

> 生成文件目录列表到Markdown文件中

Latest version **0.1.0** (published 2021-07-28) · 0 weekly downloads

## Install

```sh
npm install node-file-tree-md
pnpm add node-file-tree-md
yarn add node-file-tree-md
bun add node-file-tree-md
```

Provides the command `md-file-tree`.

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-07-28 |
| First published | 2021-07-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | xlzy520 |
| Maintainers | zhibi |

## Links

- npm: https://www.npmjs.com/package/node-file-tree-md
- Repository: https://github.com/xlzy520/md-file-tree
- Homepage: https://github.com/xlzy520/md-file-tree#readme
- Issues: https://github.com/xlzy520/md-file-tree/issues
- npm.io page: https://npm.io/package/node-file-tree-md

## Dependencies (1)

- [event-state](https://npm.io/package/event-state.md) ^0.3.5

## Recent versions

- 0.1.0 (latest) — 2021-07-28

## README

# node-file-tree-md

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

## How to use?

### Install the script

```bash
$ npm install node-file-tree-md
```

### 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)
```

### Redirect the output to a file with file prefix

```bash
$ md-file-tree > list.md -p html
```
This generates the `list.md` file with:

```markdown
- __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.

---
_Source: https://npm.io/package/node-file-tree-md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._