smart-editor-v3 1.15.0 → 1.15.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +91 -24
- package/dist/smart-editor-package.js +1388 -1370
- package/dist/style.css +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,39 +2,106 @@
|
|
|
2
2
|
|
|
3
3
|
## 简介
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
smart-editor-v3 是一款基于 Tiptap 编辑器核心进行深度二次开发的富文本编辑器引擎。项目初衷源自团队在实际业务中使用 WangEditor 5 所面临的功能扩展困难与性能瓶颈。为更好地支持电子教材创作中复杂的排版、嵌入式内容、多媒体管理等需求，我们从底层架构出发，打造了这套高可定制、插件化、模块化的编辑解决方案。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
该引擎以 Vue 3 组件形式封装，旨在为教材创作者、编辑人员以及相关业务系统的开发者，提供一个既灵活又稳定的内容编辑能力。其设计注重集成便捷性与业务可拓展性，特别适用于需要引入富文本编辑器或电子教材阅读功能的项目。
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## 核心功能
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
1. 支持常见的富文本编辑器的基本文本和段落编辑，
|
|
12
|
+
2. 一系列业务端的自定义节点（包括拼音，iframe，音视频，扩展阅读，试卷，行内元素等）
|
|
13
|
+
3. 创新型板式插入模式，实现类似于135编辑器的排版效果
|
|
14
|
+
4. 利用indexdDB的本地化缓存方案
|
|
15
|
+
5. 复制和粘贴内容代理，输入内容可控
|
|
16
|
+
6. AI的深度集成，可直接插入ai生成的内容
|
|
17
|
+
|
|
18
|
+
## 开发环境搭建
|
|
19
|
+
|
|
20
|
+
#### 系统要求
|
|
21
|
+
|
|
22
|
+
- Node.js : 推荐使用 v18.x 或更高版本
|
|
23
|
+
- 包管理器 : 推荐使用 pnpm v8.x 或更高版本
|
|
24
|
+
- 操作系统 : 支持 macOS、Windows 和 Linux
|
|
25
|
+
|
|
26
|
+
#### 安装pnpm
|
|
14
27
|
|
|
15
|
-
|
|
28
|
+
#### 安装依赖
|
|
16
29
|
|
|
17
|
-
|
|
18
|
-
<template>
|
|
19
|
-
<umo-editor v-bind="options" />
|
|
20
|
-
</template>
|
|
30
|
+
> 项目使用 pnpm 作为包管理工具，并且需要访问 Tiptap Pro 私有仓库：注意 ：项目依赖 Tiptap Pro 的扩展包，已在 .npmrc 文件中配置了相应的仓库地址和认证令牌。
|
|
21
31
|
|
|
22
|
-
|
|
23
|
-
<script setup>
|
|
24
|
-
import { ref } from 'vue'
|
|
25
|
-
import { UmoEditor } from '@umoteam/editor'
|
|
32
|
+
#### 启动开发服务器
|
|
26
33
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
// ...
|
|
30
|
-
})
|
|
31
|
-
</script>
|
|
34
|
+
```node
|
|
35
|
+
pnpm dev
|
|
32
36
|
```
|
|
33
37
|
|
|
34
|
-
##
|
|
38
|
+
## 项目结构说明
|
|
39
|
+
|
|
40
|
+
#### 项目结构说明
|
|
41
|
+
|
|
42
|
+
```base
|
|
43
|
+
📦 项目根目录
|
|
44
|
+
├─ 📁 build # 构建脚本/工具配置（通常存放打包相关脚本）
|
|
45
|
+
├─ 📁 dist # 生产环境构建输出目录（打包后的最终产物）
|
|
46
|
+
├─ 📁 node_modules # 项目依赖的第三方包（由 pnpm 自动生成）
|
|
47
|
+
├─ 📁 public # 静态资源目录（不会被构建工具处理）
|
|
48
|
+
├─ 📁 src # 核心源代码目录
|
|
49
|
+
│ ├─ 📁 assets # 静态资源目录（图片/字体/媒体文件等）
|
|
50
|
+
│ ├─ 📁 composables # Vue 组合式 API 逻辑封装（复用功能模块）
|
|
51
|
+
│ ├─ 📁 extensions # 扩展功能模块（插件/编辑器扩展等）
|
|
52
|
+
│ ├─ 📁 locales # 国际化多语言文件（i18n 配置）
|
|
53
|
+
│ ├─ 📁 styles # 全局样式文件（CSS/SCSS/UnoCSS 样式）
|
|
54
|
+
│ ├─ 📁 utils # 工具函数库（通用工具方法）
|
|
55
|
+
│ ├─ 📄 App.vue # Vue 应用根组件（做组件测试使用）
|
|
56
|
+
│ ├─ 📄 main.js # 应用入口文件（Vue 初始化/全局配置）
|
|
57
|
+
│ ├─ 📄 options.js # 编辑器配置选项
|
|
58
|
+
│ └─ 📄 slimOptions.js # 精简版编辑器配置选项
|
|
59
|
+
├─ 📁 .vscode # VS Code 工作区配置
|
|
60
|
+
├─ 📄 .editorconfig # IDE基础配置（统一团队编码风格）
|
|
61
|
+
├─ 📄 .gitignore # Git 忽略规则配置
|
|
62
|
+
├─ 📄 .npmrc # npm 配置（tiptap认证信息）
|
|
63
|
+
├─ 📄 eslint.config.js # ESLint 配置文件（代码质量检查规则）
|
|
64
|
+
├─ 📄 eslint-global-variables.json # ESLint 全局变量声明
|
|
65
|
+
├─ 📄 index.html # 应用入口 HTML 文件
|
|
66
|
+
├─ 📄 jsconfig.json # JavaScript 项目配置（路径别名/类型检查等）
|
|
67
|
+
├─ 📄 package.json # 项目元数据和依赖管理
|
|
68
|
+
├─ 📄 pnpm-lock.yaml # pnpm 依赖锁文件（确保依赖版本一致性）
|
|
69
|
+
├─ 📄 README.md # 项目说明文档
|
|
70
|
+
├─ 📄 uno.config.js # UnoCSS 原子化引擎配置
|
|
71
|
+
└─ 📄 vite.config.js # Vite 构建工具配置（开发/打包核心设置）
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### 核心目录功能详解
|
|
75
|
+
|
|
76
|
+
1. composables/
|
|
77
|
+
|
|
78
|
+
- 存放 Vue 3 Composition API 的可复用逻辑
|
|
79
|
+
- 示例文件：i18n.js, useMarkdownParse.js 等
|
|
80
|
+
- 特点：解耦复杂逻辑，实现功能复用
|
|
81
|
+
|
|
82
|
+
2. extensions/
|
|
83
|
+
|
|
84
|
+
- 编辑器自定义扩展
|
|
85
|
+
- 采用模块化设计，便于功能插拔
|
|
86
|
+
|
|
87
|
+
3. locales/
|
|
88
|
+
|
|
89
|
+
- 国际化语言包（通常按语言分文件）
|
|
90
|
+
- 配合 vue-i18n 实现多语言切换
|
|
91
|
+
|
|
92
|
+
4. styles/
|
|
93
|
+
|
|
94
|
+
- 全局样式管理体系
|
|
95
|
+
|
|
96
|
+
5. 编辑器配置文件
|
|
97
|
+
|
|
98
|
+
- options.js：完整功能配置
|
|
99
|
+
- slimOptions.js：轻量版配置（适用于简化场景，试题库）
|
|
100
|
+
|
|
101
|
+
## [其他说明文档见团队飞书知识库](https://o00i7ra5yrz.feishu.cn/wiki/GHRBwoLFFiEonxkbPPScgzHgnXb?fromScene=spaceOverview)
|
|
35
102
|
|
|
36
|
-
|
|
103
|
+
#### [架构设计](https://o00i7ra5yrz.feishu.cn/wiki/ADmIwErlNiA5klkr4B1cYbsjn9d?from=from_copylink)
|
|
37
104
|
|
|
38
|
-
|
|
105
|
+
#### [扩展设计文档](https://o00i7ra5yrz.feishu.cn/wiki/TIljwkQp2ibdJWkndfncyVAUnNd?from=from_copylink)
|
|
39
106
|
|
|
40
|
-
|
|
107
|
+
#### [构建与发布](https://o00i7ra5yrz.feishu.cn/wiki/X58VweXdViSTErkYRM0cBVafnzf?from=from_copylink)
|