markdown 之專案目錄檔案結構展示
阿新 • • 發佈:2018-12-16
一般來說,我們為專案寫readme文件時,都會對整個目錄的專案結構做個說明。
例如這樣的:
我們可以用mddir來生成專案目錄結構:mddir
使用命令
node mddir "../relative/path/"
例子
開啟終端或命令提示符,並cd進入mddir /src資料夾。
使用說明:
$ cd ~/Documents/demo-project $ pwd Users/username/Documents/demo-project $ npm install mddir --save $ cd node_modules/mddir/src $ pwd Users/username/Documents/node_modules/mddir/src $ ls mddir.js $ node mddir "../../../" // Exports 'directoryList.md' in mddir/src folder
如果沒有指定路徑,mddir將預設為mddir/src資料夾之上上的三個資料夾
(假設mddir安裝在:project/node_modules/mddir/src中)。
生成的目錄會忽略node_modules和.git資料夾。