Fitten Code快速编写README:根据项目结构自动生成美观的说明文档

老伟君_6320

老伟君_6320

2026-06-22

426人浏览

原创

使用fitten code插件可在vs code中一键生成带图标和目录的readme.md:安装后重启,右键项目根目录选择“generate readme”,支持通过.fittenrc.json或命令配置内容,生成后可预览、导航并保存。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

fitten code快速编写readme:根据项目结构自动生成美观的说明文档

想在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"]}

VS Code Node
VS Code Node

通过作为 OpenClaw 节点连接的 VS Code/Cursor IDE 操作代码,提供 40 多种命令,涵盖文件操作、语言智能、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。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

fitten code vs code

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

582

19

WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

582

19

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

80

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

80

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

40

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

40

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

60

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

280

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

160

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Fitten Code官方手册
Fitten Code官方手册

共0课时 | 0人学习

Codebuddy 插件
Codebuddy 插件

共0课时 | 0人学习

Fitten Code官方手册
Fitten Code官方手册

共0课时 | 0人学习