mddir自动生成文件目录结构工具

mddir是一个基于项目目录结构动态生成目录机构md文件的工具，它可以帮助梳理项目的基本结构。

使用mddir可以将目录结构输出为 Markdown 格式，方便在文档中展示文件和文件夹的组织结构。通过使用 mddir，可以快速生成包含文件和文件夹的目录结构，以及为其添加标题、缩进和链接等样式。

├── node_modules # 安装的包
├── public  # 静态资源托管目录
│   ├── favicon.ico
│   └── index.html
└── src  # 源码
    ├── api  #请求接口封装模块
      └── index.js #封装请求方法
    ├── assets  #资源目录
    ├── components  #组件目录
    ├── router  #路由模块
      └── index.js #路由对象
    ├── store  #Vuex容器模块
      └── index.js #store对象
    ├── styles #样式目录
    ├── utils  #工具模块目录
    ├── views  #视图组件目录
    ├── App.vue  #根组件
    └── main.js  #入口文件
├── .browserslistrc # 浏览器的约定
├── .editorconfig #对本项目要用到编辑器的约定
├── .eslintrc.js #eslint
├── .gitignore # git的忽略设置
├── babel.config.js  #babel配置文件
├── package-lock.json  #npm相关文件
├── package.json  #npm相关文件
└── README.md  #项目说明文件

安装

npm install mddir -g

使用

安装完毕，直接进入项目根目录，执行命令 mddir 即可在根目录下生成一个directoryList.md的文件，打开该文件就可以看到了项目的结构。

cd demo

mddir