使用 mddir 生成目錄結構圖(工程結構圖)

在寫項目 README.md 說明文檔時,若是有一個 markdown 目錄結構圖就很 nice 了css

前人栽樹後人乘涼,無獨有偶,npm 上已經有這樣的一個包:mddir ,咱們能夠使用它來爲項目生成目錄結構圖html

使用以下:node

# 一、項目中安裝 mddir(若是要全局安裝,須要將 mddir 配置環境變量)
$ yarn add mddir -D
# or npm install mddir -D

# 二、執行命令,生成結構圖
# 具體要生成哪一個目錄的結構圖,看本身需求
# node node_modules/mddir/src/mddir [you folder](可選,默認當前目錄)
$ node node_modules/mddir/src/mddir
複製代碼

執行命令後會在當前目錄下生成一個 directoryList.md 的 md 文件webpack

內容以下:git

|-- 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
   |   |-- start.js
   |   |-- test.js
   |-- src
       |-- App.css
       |-- App.js
       |-- App.test.js
       |-- index.css
       |-- index.js
       |-- logo.svg
       |-- api
       |   |-- index.js
       |-- components
       |   |-- hello.jsx
       |   |-- hoc.jsx
       |   |-- stoneForm.jsx
       |   |-- template.jsx
       |-- router
       |   |-- routes.jsx
       |-- store
       |   |-- index.jsx
       |-- utils
       |   |-- cookie.js
       |   |-- module.js
       |-- views
           |-- home
           |   |-- Home.jsx
           |   |-- home.css
           |-- login
           |   |-- Login.jsx
           |-- template
               |-- common.jsx

複製代碼

更多詳細說明請看官方文檔介紹:mddirweb

相關文章
相關標籤/搜索