生成文件夹目录树结构给markdown使用

1、背景介绍

​ 今天写为公司新搭建项目说明文档，在介绍项目目录结构时，需要在markdown中展示项目的目录结构。在完成工作需要后，记录一下使用treer工具的过程。

2、treer安装

2.1 执行下面的命令安装treer

npm install treer -g

2.2 treer -h查看用法介绍

C:\Users\Administrator>treer -h
Usage: index [options]

Options:
  -V, --version          查看版本信息
  -d, --directory [dir]  指定要生成目录树结构的目录 (默认: "C:\\Users\\Administrator")
  -i, --ignore [ig]      在目录树结构中忽略的目录
  -e, --export [epath]   将目录树结构的信息输出到文件中
  -h, --help             查看帮助信息

3、生成目录树结构

3.1 打开cmd，执行命令

D:\>treer -d D:\test -e D:\test.txt
D:\test
├─test2
|   ├─test22
|   |   └test22.txt
|   ├─test21
├─test1
|   ├─test12
|   ├─test11
|   |   └test11.txt

将生成的txt中的内容根据实际需要进行调整后，拷贝到markdown中即可使用。

​