You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在VS Code或CMD中快速生成Readme.md中的项目目录结构?

生成项目目录结构并写入README.md的简便方法

不管是用CMD还是VS Code,都有快速生成目录结构并写入README的实用方案,下面分场景说明:

一、CMD(Windows命令提示符)方式

Windows自带的tree命令就能直接搞定,步骤如下:

  1. 打开项目根目录,右键选择「在此处打开命令窗口」
  2. 执行命令:
tree /f /a > README.md
  • /f:显示目录下的所有文件(默认仅展示文件夹)
  • /a:用ASCII字符绘制结构线,避免出现乱码特殊符号

如果需要排除特定目录(比如node_modules、.git),可以配合findstr过滤:

tree /f /a | findstr /v /i "node_modules .git" > README.md
  • /v:排除匹配到的内容
  • /i:忽略大小写,避免漏过滤大小写不同的目录名

执行完成后,你的README.md会自动写入格式化好的目录结构。

二、VS Code方式

1. 内置终端执行命令

打开VS Code,按下Ctrl+``打开内置终端,直接运行上面的tree`命令,效果和CMD完全一致,生成内容会直接写入README。

2. 插件一键生成

推荐使用Generate Folder Structure插件:

  • 安装插件后,右键点击项目根文件夹,选择「Generate Folder Structure」
  • 在弹出设置窗口里,可配置是否显示文件、排除指定目录/文件、调整结构样式
  • 生成后可以直接复制内容到README,也能选择「Export to File」直接写入README.md

另外Tree View to Markdown插件也能实现类似功能,选顺手的用就行。

示例效果

实际目录结构截图:
项目实际目录结构

在README.md中展示的效果:

my-vue-project/
├─ src/
│  ├─ components/
│  │  ├─ Nav.vue
│  │  └─ List.vue
│  ├─ views/
│  │  └─ Index.vue
│  └─ main.js
├─ public/
│  └─ index.html
├─ package.json
└─ README.md

内容的提问来源于stack exchange,提问作者Gautam Sharma

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.19 16:20:09