Markdown 中我们经常会看到这样的描述目录的结构,但是 Markdown
并没有这样的语法用来生成这样的目录描述,那是怎么搞的呢?难道一个个字符的输入?实际上一些第三方工具可以生成这样的目录结构文本,然后拷贝到 Markdown 中。
系统要求
window10系统
mac系统、linux系统没有尝试过,感兴趣的小伙伴可以自行尝试一下。
环境要求
安装node.js,查看是否安装,请输入命令
node -v 和 npm -v
如有版本输出,便可顺利往下进行。否则先自行安装node.js,node.js安装过程这里就不在再一点点描述了。
安装全局工具tree
npm i tree-node-cli -g
这里有个地方需要注意一下,在安装前先cmd
打开命令窗口,输入命令tree
如果显示目录结构说明window系统本身有tree工具,所有在安装过程后,不能再用tree命令了(window中的tree工具生成的目录不是很美观),那变成什么了呢,其实不用担心,执行完以上命令后,会输出安装的路径,你会清晰的看到tree变成treee
,多了个e,treee
就是npm安装的命令,这样就可以使用treee
了。
查看tree命令帮助
treee --help
tree 命令部分常用命令
- tree -a 显示所有
- tree -d 只显示文档夹
- tree -L n 显示项目的层级,n表示层级数,比如想要显示项目三层结构,可以用tree -l 3;
- tree -I pattern 用于过滤不想要显示的文档或者文档夹。比如你想要过滤项目中的 node_modules 文档夹,可以使用
tree -I “node_modules”; - tree > tree.md 将项目结构输出到 tree.md 这个文档
生成树状目录结构
-L 是确定要几级目录,-I是排除哪个文件夹,然后我是要在README里面生成项目结构树
先cd到需要生成目录的文件夹下,然后输入命令,及将结构输入到文件中
如:treee -L 4 -I “node_modules” > README.md
treee > tree.md