一、什么是mddir?
在平時寫博客或者記錄一個項目的時候,總是會先梳理一下項目基本機構,也就是希望展示如下所示圖形。
之前都是手寫,很累,偶然發現一個工具可以基於項目目錄結構動態生成目錄機構md文件,所以特此記錄一下,這個工具的使用方法。
二、安裝
通過npm全局安裝。
npm install mddir -g
三、使用
安裝完畢,直接進入項目根目錄,執行命令 mddir 即可在根目錄下生成一個directoryList.md的文件。
如上圖所示,把第一行的undefined手動換成項目名稱即可,這里是vuex-demo。最終效果如下。
如果需要在md文件中展示,需要前后包裹 ``` ,以便按格式顯示。很方便。