在写项目 README.md 说明文档时，如果有一个 markdown 目录结构图就很 nice 了
例如：https://gitee.com/zoomla/ZoomlaFont
这个项目中，就有很好的目录结构。

前人栽树后人乘凉，无独有偶，npm 上已经有这样的一个包：mddir ，我们可以使用它来为项目生成目录结构图

使用如下：

1、项目中安装 mddir（如果要全局安装，需要将 mddir 配置环境变量）

yarn add mddir -D

或者

npm install mddir -g

2、执行命令，生成结构图

具体要生成哪个目录的结构图，看自己需求

# node node_modules/mddir/src/mddir [you folder](可选，默认当前目录)
$ node node_modules/mddir/src/mddir

注意：当前目录下必须有子目录，如果没有子目录是无法生成的。
如果你不需要指定在特定目录，则具体生成方法就是执行命令mddir

mddir

执行后，会有一段时间等待，视文件目录的大小而定。
在一段时间等待后，在当前目录下生成一个 directoryList.md 的 md 文件

内容如下：
内容如下：

|— Html5
|— .babelrc
|— .gitignore
|— README.md
|— directoryList.md
|— gulpfile.js
|— package.json
|— yarn.lock
|— config
| |— env.js
| |— paths.js
| |— polyfills.js
| |— webpack.config.dev.js
| |— webpack.config.prod.js
| |— jest
| |— cssTransform.js
| |— fileTransform.js
|— public
| |— favicon.ico
| |— index.html
|— scripts
| |— build.js

当然，该文件如果直接在md中浏览，会是合并成一行的。
在使用时，你应该在前面加上空行，后面加上空行，就可以进行正常的目录式浏览了，是不是很方便 ？

附该项目的NPM网址：
https://www.npmjs.com/package/mddir