在寫項(xiàng)目 README 說明文檔時(shí)奴烙,都會對整個目錄的項(xiàng)目結(jié)構(gòu)做個說明助被。例如:
|-- .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 來為項(xiàng)目生成目錄結(jié)構(gòu)圖剖张。
使用如下:
1、項(xiàng)目中安裝 mddir
(如果要全局安裝揩环,需要將 mddir
配置環(huán)境變量)
cnpm i mddir --save
2搔弄、執(zhí)行命令,生成結(jié)構(gòu)圖
node node_modules/mddir/src/mddir [you folder](可選丰滑,默認(rèn)當(dāng)前目錄)
執(zhí)行命令后會在當(dāng)前目錄下生成一個 directoryList.md
的 md
文件顾犹,內(nèi)容如下:
生成的目錄會忽略 node_modules
和 .git
文件夾。