AI Generate Markdown

一个智能的VSCode扩展，可以自动分析项目结构并使用AI技术生成高质量的README.md文件。

功能特性

• 🔍 智能项目分析: 自动扫描项目结构，识别技术栈和主要文件
• 🤖 AI驱动生成: 使用LangChain和OpenAI API生成专业的README内容
• 📝 多种模板: 支持专业、技术、轻松三种写作风格
• 🌐 多语言支持: 支持中文和英文README生成
• ⚙️ 自定义配置: 可选择包含的README部分和内容
• 📊 项目分析报告: 生成详细的项目结构分析报告

快速开始

1. 安装扩展

在VSCode扩展市场搜索 "AI Generate Markdown" 并安装。

2. 配置API Key

首次使用需要配置OpenAI API Key：

1. 打开命令面板 (Ctrl+Shift+P 或 Cmd+Shift+P)
2. 搜索并执行 AI Generate Markdown: 配置 OpenAI API Key
3. 输入您的OpenAI API Key

3. 生成README

有两种方式生成README：

方法一：通过命令面板

• 打开命令面板，搜索 AI Generate Markdown: 生成 README.md

方法二：通过右键菜单

• 在文件资源管理器中右键点击项目文件夹
• 选择 生成 README.md

支持的项目类型

• 前端项目: React, Vue.js, Angular, HTML/CSS/JS
• 后端项目: Node.js, Express, Python, Java
• 移动开发: React Native, Flutter, Dart
• 桌面应用: Electron
• 其他: 任何包含package.json的项目

可用命令

配置选项

可以在VSCode设置中配置以下选项：

• aiGenMarkdown.openaiApiKey: OpenAI API Key
• aiGenMarkdown.defaultLanguage: 默认语言 (zh/en)
• aiGenMarkdown.defaultStyle: 默认风格
• aiGenMarkdown.includeProjectStructure: 是否包含项目结构
• aiGenMarkdown.includeTechnologies: 是否包含技术栈

生成的README结构

根据配置，生成的README可能包含以下部分：

1. 项目标题和描述
2. 技术栈 (可选)
3. 项目结构 (可选)
4. 安装说明 (可选)
5. 使用方法 (可选)
6. 功能特性
7. 贡献指南 (可选)
8. 许可证 (可选)

故障排除

API连接问题

如果遇到连接问题：

1. 检查API Key是否正确配置
2. 确认网络连接正常
3. 使用 测试 LangChain 连接 命令验证
4. 如果API调用失败，扩展会自动使用模板生成README

文件权限问题

如果无法写入README文件：

1. 确认对项目目录有写入权限
2. 如果README.md已存在，扩展会询问是否覆盖

技术实现

• 项目分析: 基于文件系统扫描和package.json解析
• AI生成: 使用LangChain框架和OpenAI GPT模型
• 模板回退: 当AI生成失败时自动使用本地模板
• VSCode集成: 原生VSCode扩展API和用户界面

开源协议

MIT License

反馈和支持

如果您遇到问题或有改进建议，请：

1. 查看控制台输出获取详细错误信息
2. 确认配置是否正确
3. 尝试重新安装扩展

注意: 使用本扩展需要有效的OpenAI API Key，API调用可能产生费用。