#在 README.md 中生成項目目錄結(jié)構(gòu)

生成項目的目錄結(jié)構(gòu)

需求:當編寫項目文檔時,需要在 README.md 中對項目整體的目錄結(jié)構(gòu)以及文件的功能進行說明。

系統(tǒng):macOS Mojave Version 10.14.2(18c54)

步驟:1.使用 Homebrew 安裝 tree 2.使用 tree 在控制臺生產(chǎn)當前目錄樹 > tree.text 3.復制目錄樹文本到 README.md 中

1.使用 Homebrew 安裝 tree

  // $ 表示這是一個命令行,$ 不需要輸入
  $ brew install tree
01-brew install tree.png
02-brew install tree completed.png

2.使用 tree 在控制臺生產(chǎn)當前目錄樹

// 因為實例項目為 js 項目,所以忽略了 node_modules,可根據(jù)真實項目選擇性忽略文件目錄,防止文件樹過長
$ tree -I node_modules > tree.text
03-generage_tree.png

3.復制目錄樹文本到 README.md 中

04-copy_directory_tree_txt_to_readme.png

4.done !接下來可以根據(jù)具體需求寫具體注釋了。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容