# Milkdown 全屏 WYSIWYG Markdown 编辑器实施方案 ## 项目概述 基于 `@milkdown/crepe` 实现全屏覆盖的所见即所得 Markdown 编辑器,替换现有的 contenteditable 编辑器。 ## 技术选型 - **核心编辑器**: `@milkdown/crepe` - 功能完整的 WYSIWYG Markdown 编辑器 - **Vue 集成**: `@milkdown/vue` - Vue 3 组件支持 - **主题**: `frame`(简洁框架主题) ## 系统架构 ```mermaid graph TB A[App.vue] --> B[MilkdownProvider] B --> C[Milkdown Editor - Crepe] subgraph "Crepe 核心功能" D[WYSWIYG 编辑体验] E[Markdown 语法即时渲染] F[斜杠命令菜单 Slash Commands] G[代码块高亮] H[图片粘贴支持] end subgraph "集成功能" I[GhostTextOverlay
建议文本显示] J[InlineSuggestionPlugin
智能补全] end C --> I C --> J ``` ## 实施步骤 ### Step 1: 安装依赖包 ```bash npm install @milkdown/crepe @milkdown/vue ``` ### Step 2: 创建 Milkdown 编辑器组件 **文件**: `src/components/MilkdownEditor.vue` #### 核心实现要点 ```vue ``` ### Step 3: 更新 App.vue - 移除旧的 `MarkdownEditor` 组件引用 - 使用新的 `MilkdownEditor` 组件 - 保持全屏布局(100vh × 100vw) ### Step 4: 添加样式配置 在 `main.js` 中导入 Crepe 主题: ```js import '@milkdown/crepe/theme/common/style.css' import '@milkdown/crepe/theme/frame.css' ``` ## 已知问题及修复方案 ### 🔴 严重问题(P0) #### 1. 模板语法错误 **位置**: `MilkdownEditor.vue:7-13` **问题**: GhostTextOverlay 组件标签缺少尖括号 **修复**: 使用正确的 Vue 组件标签语法 `` 和 `` #### 2. 字符串截取错误 **位置**: `MilkdownEditor.vue:155` **问题**: `prefix.substring(-50)` 在 JavaScript 中会返回整个字符串 **修复**: 改为 `prefix.slice(-50)` 或 `prefix.substring(prefix.length - 50)` #### 3. 错误处理违反原则 **位置**: `MilkdownEditor.vue:92-94` **问题**: 请求失败时返回空字符串而不是抛出错误 **修复**: 遵循"获取失败直接报错"原则,抛出异常而不是返回默认值 ### 🟡 中等问题(P1) #### 4. 内存泄漏风险 **问题**: 组件卸载时没有清理 `debounceTimer` **修复**: 添加 `onUnmounted` 生命周期钩子,清理定时器和编辑器实例 #### 5. 不可靠的事件绑定 **问题**: 使用硬编码的 500ms 延迟等待编辑器创建 **修复**: 在 `await crepe.create()` 后直接调用 `initEditorEvents()` #### 6. 代码重复 **问题**: `fetchSuggestion` 逻辑在两个文件中重复 **修复**: 将共享逻辑提取到独立的工具函数或服务中 #### 7. 全局状态污染 **问题**: 插件使用模块级全局变量 **修复**: 使用 ProseMirror 插件的状态管理机制 ### 🟢 轻微问题(P2) #### 8. 大量调试日志 **问题**: 代码中包含大量 `console.log` 调试语句 **修复**: 移除或条件化调试日志 #### 9. 缺少类型定义 **问题**: TypeScript 代码中缺少完整的类型定义 **修复**: 添加完整的 TypeScript 类型定义 #### 10. 没有加载状态 **问题**: 用户无法知道是否正在获取建议 **修复**: 添加加载状态指示器 #### 11. 建议文本无长度限制 **问题**: 建议文本可能过长 **修复**: 添加建议文本长度限制 #### 12. API URL 硬编码 **问题**: API URL 硬编码在前端代码中 **修复**: 使用环境变量配置 API URL #### 13. 缺少 CORS 配置 **问题**: 后端没有配置 CORS **修复**: 在 FastAPI 中添加 CORS 中间件 ## 全屏覆盖样式要点 - 编辑器容器: `width: 100vw; height: 100vh` - 移除默认 padding/margin - 纯编辑器模式,无预览面板 - 自定义滚动条样式 ## 性能优化建议 1. **防抖优化**: 保持 150ms 防抖,避免频繁请求 2. **流式响应**: 使用 SSE 流式传输,降低延迟 3. **上下文截取**: 智能截取上下文(光标前30行 + 后5行) 4. **内存管理**: 及时清理定时器和事件监听器 5. **代码精简**: 移除冗余代码和注释 ## 测试要点 1. 编辑器基本功能测试 2. 建议功能测试(Tab 接受、Esc 取消、点击接受) 3. 错误处理测试(网络错误、API 错误) 4. 性能测试(大量文本输入) 5. 内存泄漏测试(长时间使用)