时光轴

使用 mddir 生成目录结构图(工程结构图)

2020-08-14  本文已影响0人  侯工

在写项目 README 说明文档时,都会对整个目录的项目结构做个说明。例如:

|-- .gitignore
|-- babel.config.js
|-- package-lock.json
|-- package.json
|-- README.md
|-- public
|   |-- favicon.ico
|   |-- index.html
|-- src
    |-- App.vue
    |-- main.js
    |-- assets
    |   |-- logo.png
    |-- components
    |   |-- HelloWorld.vue

我们可以使用 mddir 来为项目生成目录结构图。

使用如下:

1、项目中安装 mddir(如果要全局安装,需要将 mddir 配置环境变量)
cnpm i mddir --save
2、执行命令,生成结构图
node node_modules/mddir/src/mddir [you folder](可选,默认当前目录)

执行命令后会在当前目录下生成一个 directoryList.mdmd 文件,内容如下:

生成的目录会忽略 node_modules.git 文件夹。

上一篇下一篇

猜你喜欢

热点阅读