https://github.com/iakoug/tree-md-cli

Generate a tree markdown file according to a specified directory.
https://github.com/iakoug/tree-md-cli

cli directory markdown tree-markdown tree-md-cli

Last synced: 1 day ago
JSON representation

Generate a tree markdown file according to a specified directory.

• Host: GitHub
• URL: https://github.com/iakoug/tree-md-cli
• Owner: iakoug
• Created: 2018-11-29T09:41:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-28T05:05:35.000Z (over 5 years ago)
• Last Synced: 2025-02-06T17:12:35.546Z (4 days ago)
• Topics: cli, directory, markdown, tree-markdown, tree-md-cli
• Language: JavaScript
• Homepage:
• Size: 11.7 KB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tree-md-cli

使用命令将制定目录下文件和文件夹生成指定树形markdown文档

### Getting Started

```

  npm i tree-md-cli -g

  tree-md

```

### 使用

```

  tree-md init

  // 或

  tree-md-init

```

在当前目录生成以下mardown文件（会默认忽略git以及node_modules目录）

example：

``` js 

|-- treeDir

    |-- .DS_Store

    |-- .gitignore

    |-- README.md

    |-- index.js

    |-- package-lock.json

    |-- package.json

    |-- .vscode

    |   |-- launch.json

    |-- bin

    |   |-- index.js

    |   |-- init.js

    |-- config

    |   |-- index.js

    |-- lib

        |-- .DS_Store

        |-- index.js

```