一焰檩、安裝 Node 和 Git
下載 Node.js 和 Git,網(wǎng)上教程很多订框,這里不再贅述析苫。
二、安裝 tree-node-cli
在項(xiàng)目的根文件夾下鼠標(biāo)右鍵打開(kāi) Git Bash Here
:
image
輸入下面命令進(jìn)行安裝:
npm install -g tree-node-cli
image
三穿扳、自動(dòng)生成目錄樹(shù)結(jié)構(gòu)
輸入下面命令:
tree -L 4 -I "Scripts|Lib|pycache" > tree.md
image
解釋:
-
tree -L n
顯示項(xiàng)目的層級(jí)衩侥。n 表示層級(jí)數(shù)。比如你想要顯示項(xiàng)目的 4 層結(jié)構(gòu)矛物,可以用tree -L 4
茫死。 -
tree -I "Scripts|Lib|pycache"
表示要過(guò)濾的文件夾/目錄。 -
tree > tree.md
表示將結(jié)構(gòu)輸出到 tree.md 這個(gè)文件履羞。
更多操作可以輸入 tree --help
進(jìn)行查看:
Options:
-V, --version output the version number
-a, --all-files All files, include hidden files, are printed.
--dirs-first List directories before files.
-d, --dirs-only List directories only.
-I, --exclude [patterns] Exclude files that match the pattern. | separates alternate patterns. Wrap your entire pattern in double quotes. E.g. `"node_modules|coverage".
-L, --max-depth <n> Max display depth of the directory tree.
-r, --reverse Sort the output in reverse alphabetic order.
-F, --trailing-slash Append a '/' for directories.
-h, --help output usage information
查看 tree.md 文件里的內(nèi)容:
image
這樣就能直接復(fù)制內(nèi)容寫(xiě)進(jìn) GitHub 項(xiàng)目里的 README 中了璧榄,超級(jí)方便,而且很有條理吧雹。