Instruction file imported from whateveryoudo/speed-tiptap-editor (
.cursor/rules/project-structure.mdc). Copyright stays with the author.
项目结构指南
这是一个基于 Vue 3 + TypeScript + Tiptap 编辑器项目,集成了 Ant Design。
涉及到样式生成的情况下,采用如下的优先级: ant-design-vue组件库 > uno.css > 定义class > 行内style
关键目录
src/components/:Vue 组件,包括颜色选择器、模态框、菜单等src/extensions/:Tiptap 编辑器扩展(链接、思维导图、流程图等)src/assets/style/:CSS/Less 文件,包括 Ant Design 变量src/menus/:编辑器工具栏菜单组件src/helpers/:工具函数和辅助函数src/hooks/:Vue 组合式 API 钩子src/prose-utils/:Tiptap/ProseMirror 工具函数
主要文件
src/editor.vue:主编辑器组件src/main.ts:应用程序入口点src/extensions/kit.ts:扩展配置和设置src/assets/style/antd-variables.rule:Ant Design CSS 变量
技术栈
- 前端:Vue 3 + TypeScript + 组合式 API
- 编辑器:Tiptap 2.x(基于 ProseMirror)
- UI:Ant Design Vue 4.x
- 样式:Less + CSS 变量
- 构建:Vite
扩展系统
项目使用自定义的 Tiptap 扩展系统:
- 支持 Markdown 语法的自定义链接扩展
- 基于 kityminder 的思维导图扩展
- 基于 X6 的流程图扩展
- 各种文本格式化扩展
参考:kit.ts - 展示了如何配置和加载扩展。
项目结构指南
这是一个基于 Vue 3 + TypeScript + Tiptap 编辑器项目,集成了 Ant Design。
关键目录
src/components/:Vue 组件,包括颜色选择器、模态框、菜单等src/extensions/:Tiptap 编辑器扩展(链接、思维导图、流程图等)src/assets/style/:CSS/Less 文件,包括 Ant Design 变量src/menus/:编辑器工具栏菜单组件src/helpers/:工具函数和辅助函数src/hooks/:Vue 组合式 API 钩子src/prose-utils/:Tiptap/ProseMirror 工具函数
主要文件
src/editor.vue:主编辑器组件src/main.ts:应用程序入口点src/extensions/kit.ts:扩展配置和设置src/assets/style/antd-variables.rule:Ant Design CSS 变量
技术栈
- 前端:Vue 3 + TypeScript + 组合式 API
- 编辑器:Tiptap 2.x(基于 ProseMirror)
- UI:Ant Design Vue 4.x
- 样式:Less + CSS 变量
- 构建:Vite
扩展系统
项目使用自定义的 Tiptap 扩展系统:
- 支持 Markdown 语法的自定义链接扩展
- 基于 kityminder 的思维导图扩展
- 基于 X6 的流程图扩展
- 各种文本格式化扩展
参考:kit.ts - 展示了如何配置和加载扩展。