使用fitten code插件可在vs code中一键生成带图标和目录的readme.md:安装后重启,右键项目根目录选择“generate readme”,支持通过.fittenrc.json或命令配置内容,生成后可预览、导航并保存。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

想在10秒内为新项目生成一份结构清晰、带图标和目录的README.md,而不是手动敲Markdown写文件列表和功能说明。
安装Fitten Code插件
打开VS Code → 左侧活动栏点击扩展(或按 Ctrl+Shift+X)→ 搜索框输入 【Fitten Code】 → 点击“安装”按钮,等待右侧出现“重新加载”提示。
不重启VS Code会导致右键菜单里看不到“Generate README”选项,这一步不能跳过。
在项目根目录触发自动生成
确保资源管理器中已打开完整项目文件夹(不是只打开某个子文件),且当前焦点在该文件夹名称上。
右键点击项目根文件夹 → 选择“Generate README with Fitten Code” → 等待右下角弹出“README.md generated successfully”通知。
如果右键菜单没有该选项,请检查是否已将项目作为工作区打开:菜单栏 → 文件 → 将文件夹添加到工作区 → 选中当前根目录。
定制生成内容(可选)
方法一:修改配置文件
在项目根目录新建 .fittenrc.json → 写入以下内容:
{"title": "我的API服务", "include": ["src", "tests"], "exclude": ["node_modules", ".git"]}
方法二:快捷命令覆盖
按下 Ctrl+Shift+P → 输入 “Fitten: Configure Generation” → 回车 → 勾选/取消对应目录,设置后立即生效,无需重启。
【注意:.fittenrc.json 中的 exclude 项必须用双引号包裹字符串,写成 exclude: [node_modules] 会报错中断生成】
预览并保存最终版本
1. 生成完成后,编辑器自动打开 README.md 预览页
2. 查看左侧导航栏是否显示“目录”面板(含折叠/展开按钮)
3. 滚动文档,确认每个子目录旁都有对应图标(? 表示文件夹,⚙️ 表示配置文件,? 表示文本)
4. 点击任意目录项,页面自动滚动到对应章节位置
5. 按 Ctrl+S 保存文件,此时 README.md 已就绪,可直接提交到 Git。










