Giter Site home page Giter Site logo

tantm / md-file-tree Goto Github PK

View Code? Open in Web Editor NEW

This project forked from michalbe/md-file-tree

0.0 1.0 0.0 35 KB

Generate markdown list of all the files in a directory.

Home Page: https://www.npmjs.com/package/md-file-tree

License: MIT License

JavaScript 100.00%

md-file-tree's Introduction

md-file-tree by @michalbe

Generate markdown tree of all the files in a directory, recursively.

How to use?

Install the script

$ npm install md-file-tree -g

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)

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.

md-file-tree's People

Contributors

michalbe avatar mattipv4 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.