Git Product home page Git Product logo

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

mattipv4 avatar michalbe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

md-file-tree's Issues

Markdown in file names is not escaped

If your filename contains markdown characters, this script does not escape them and this means that you end up with some very weird rendering of your filenames in the generated tree.

Error when attempting to run from npm package

Problem

I get this eror when I try to run it for the first time.

PS C:\Users\shiva> md-file-tree
C:\Users\shiva\AppData\Roaming\npm\node_modules\md-file-tree\index.js:28
        Object.keys(result).sort().forEach(key => {
               ^

TypeError: Cannot convert undefined or null to object
    at Function.keys (<anonymous>)
    at parseResult (C:\Users\shiva\AppData\Roaming\npm\node_modules\md-file-tree\index.js:28:16)
    at C:\Users\shiva\AppData\Roaming\npm\node_modules\md-file-tree\index.js:42:9
    at C:\Users\shiva\AppData\Roaming\npm\node_modules\md-file-tree\walker.js:16:21
    at FSReqCallback.oncomplete (fs.js:156:23)

#Info

Version: [email protected]
Installation: global

Adding the folder name as prefix breaks relative links

Hello,

Thank you for this tool. It is amazing.
However, it has a problem (with an easy fix), it adds the folder name where the command is executed to every route path. If you are going to keep the generated markdown file at the root of the folder or github repo this fact breaks all relative links.
Please remove this prefix as default or at least provide an option to do so.

Apart from that, awesome tool man

Seems to hang with no output

Using latest version of this package with node version 14.18.1 on macOS 10.15.7, when I run npx md-file-tree . it just hangs forever with no output. ๐Ÿค”

Links with spaces break in markdown

Any links that have spaces in them do not work in markdown link format and so fail to render correctly. These should be url encoded so that they work correctly.

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.