Markdown語法:利用mddir工具自動生成文件目錄結構

Markdown語法:利用mddir工具自動生成文件目錄結構

前言

mddir是個能幫助我們快速生成markdown語法形式的文件目錄結構的工具,詳細說明請參考官方文檔https://www.npmjs.com/package/mddir

安裝mddir工具

要安裝mddir工具,必須先安裝npm包管理工具。我的npm包管理工具是在安裝node時自動安裝的,node的下載安裝地址如下:https://nodejs.org/zh-cn/download/

在命令行中輸入並執行npm install mddir -g便可完成安裝

使用mddir工具

假設現在有一個文件夾koa-server,裏面的文件目錄結構如下圖所示:
在這裏插入圖片描述

要使用mddir工具,我們首先利用命令行進入koa-server文件夾,然後輸入並執行mddir命令,最終在koa-server文件夾內會生成一個directoryList.md文件,如下圖所示:
在這裏插入圖片描述

mddir工具默認會忽略node_modules和.git文件夾。而directoryList.md文件內容如下圖所示:
在這裏插入圖片描述

第一行出現的’undefined’用父文件夾名,即koa-server代替即可。注意,上圖內容還是純文本內容,markdown解析器解析渲染之後並不會正確顯示,而是需要像markdown中的代碼塊一樣用兩個三重反引號(```)包圍起來,最終結果如下所示:

|-- koa-server
    |-- app.js
    |-- package-lock.json
    |-- package.json
    |-- bin
    |   |-- www
    |-- public
    |   |-- images
    |   |-- javascripts
    |   |-- stylesheets
    |       |-- style.css
    |-- routes
    |   |-- index.js
    |   |-- users.js
    |-- views
        |-- error.pug
        |-- index.pug
        |-- layout.pug

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章