@umoteam/editor 1.4.3 → 2.0.0-beta.1

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.
Files changed (8) hide show
  1. package/README.md +63 -72
  2. package/README.zh-CN.md +121 -0
  3. package/dist/es/style.css +1 -1
  4. package/dist/es/umo-editor.mjs +19060 -14277
  5. package/dist/umd/style.css +1 -1
  6. package/dist/umd/umo-editor.js +3 -3
  7. package/dist/umd/umo-editor.js.gz +0 -0
  8. package/package.json +17 -16
package/README.md CHANGED
@@ -2,119 +2,110 @@
2
2
  <a href="https://umodoc.com" target="_blank"><img src="https://unpkg.com/@umoteam/editor-external@latest/static/logo.svg" alt="umodoc.com" width="360" /></a>
3
3
  </p>
4
4
 
5
- <p style="text-align: center;">
5
+ <p style={{ textAlign: 'center' }}>
6
6
  <a href="https://github.com/umodoc/editor/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@umoteam/editor" /></a>
7
7
  <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/v/@umoteam/editor" /></a>
8
8
  <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/d18m/@umoteam/editor" /></a>
9
9
  </p>
10
10
 
11
- ## 基本介绍
11
+ # 中文介绍
12
12
 
13
- Umo Editor 是一个基于 Vue3 适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览、支持文档块编辑，支持添加自定义扩展。
13
+ Umo Editor 是一个基于 Vue3 适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览，支持文档块编辑，支持添加自定义扩展，支持多语言设置。
14
14
 
15
- <img src="https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor@2x.png" alt="umo editor" />
15
+ 详细介绍见： [README.zh-CN.md](https://github.com/umodoc/editor/blob/main/README.zh-CN.md)
16
16
 
17
- 作为一个独立的 Vue3 插件，Umo Editor 可以零配置轻松集成到各类 Vue3 项目中，对于非 Vue3 项目，您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
17
+ # Introduction
18
18
 
19
- ## 安装
19
+ Umo Editor is an open-source document editor based on Vue3, offering localized functionalities. It provides comprehensive document editing capabilities, supports Markdown syntax, basic rich-text editing features, a variety of node types in multiple formats, a range of practical tools, and customization of page styles. It also supports exporting in various formats, printing and print preview, document block editing, adding custom extensions, and i18n settings.
20
20
 
21
- ```bash
22
- npm config set "@tiptap-pro:registry" https://registry.tiptap.dev/
23
- npm config set "//registry.tiptap.dev/:_authToken" 9fsQEgp8C8pbxpk8PFAjYn64BtBDq6HfXmI2qgpnI7XYr/OwHaMvOUIE5mfVR49y
24
- npm install --save @umoteam/editor @umoteam/editor-external
25
- ```
21
+ <img src="https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-en@2x.png" alt="umo editor" />
26
22
 
27
- 通过其他包管理器，如 `yarn`、`pnpm` 等，请参考 [开发文档 - 快速开始](https://editor.umodoc.com/docs/getting-started)。
23
+ As a standalone Vue3 plugin, Umo Editor can be easily integrated into any Vue3 project with zero configuration. For non-Vue3 projects, you can embed Umo Editor using an Iframe.
28
24
 
29
- ## 快速开始
25
+ [Documentation](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Live Demo](https://demo.umodoc.com/editor?lang=en) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
30
26
 
31
- [开发文档](https://editor.umodoc.com/docs) | [在线演示](https://demo.umodoc.com/editor) | [GitHub](https://github.com/umodoc/editor) | [码云(国内镜像)](https://gitee.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
27
+ ## Online Experience
32
28
 
33
- ## 在线体验
29
+ Visit [Playground](https://demo.umodoc.com/editor?pane=no&lang=en) for a fast experience.
34
30
 
35
- 访问 [在线演示](https://demo.umodoc.com/editor?pane=no) 快速体验。
31
+ ## Documentation
36
32
 
37
- ## 开发文档
33
+ Please visit [Documentation](https://editor.umodoc.com/en/docs).
38
34
 
39
- 请访问 [开发文档](https://editor.umodoc.com/docs) 。
35
+ ## Design Philosophy
40
36
 
41
- ## 设计理念
37
+ Umo Editor was created to address the complexity of document editing in web applications, providing web projects with open-source and powerful editing and collaborative capabilities similar to Office Word, while maintaining the convenience of web applications. Whether it's government and enterprise information management systems, academic research writing, team document collaboration, knowledge base management, or personal note organization, Umo Editor can be a powerful assistant.
42
38
 
43
- Umo Editor 的诞生，旨在解决 Web 应用中文档编辑的复杂性，为 Web 项目提供开源免费的类似 Office Word 的强大编辑能力和协同能力，同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理，Umo Editor 都能成为您得力的助手。
39
+ ## Open Source Advantages
44
40
 
45
- ## 开源优势
41
+ - **Free to Use**: As an open-source project, Umo Editor is freely available to all developers under the [MIT License](https://github.com/umo-editor/umo-editor/blob/main/LICENSE), with no copyright concerns.
46
42
 
47
- - **免费使用**：作为开源项目，Umo Editor 基于 [MIT 许可证](https://github.com/umo-editor/umo-editor/blob/main/LICENSE) 对所有开发者免费开放，无需担心版权问题。
43
+ - **Continuous Updates**: Umo Editor will continue to iterate, constantly optimizing features and enhancing user experience.
48
44
 
49
- - **持续更新**：Umo Editor 将持续迭代，不断优化功能，提升用户体验。
45
+ - **Customizable Development**: Open source means greater flexibility. Developers can customize the development according to project needs to create a unique document editor.
50
46
 
51
- - **定制化开发**：开源意味着更大的灵活性，开发者可根据项目需求进行定制化开发，打造专属的文档编辑器。
47
+ ## Core Features
52
48
 
53
- ## 核心特性
49
+ - Zero-config out-of-the-box usability
50
+ - Lightweight
51
+ - WYSIWYG (What You See Is What You Get) throughout the process
52
+ - Rich-text editing capabilities
53
+ - Markdown syntax support
54
+ - Integrated practical tools
55
+ - Presentation mode
56
+ - Document export and sharing
57
+ - Page settings
58
+ - Support for printing and print preview
59
+ - Support for custom plugins
60
+ - Shortcut key support
61
+ - Theme customization
62
+ - Multi-language settings
54
63
 
55
- - 零配置开箱即用
56
- - 轻量级
57
- - 全过程所见即所得
58
- - 富文本编辑功能
59
- - Markdown 语法支持
60
- - 实用工具集成
61
- - 演示模式
62
- - 页面设置
63
- - 文档导出与分享
64
- - 气泡菜单与块级菜单
65
- - 快捷键支持
66
- - 支持打印及打印预览
67
- - 主题定制
64
+ For more detailed introductions, see [Core Features](./docs/features).
68
65
 
69
- 更多详细介绍见 [核心特性](https://editor.umodoc.com/docs/features)。
66
+ ## Browser Support
70
67
 
71
- ## 浏览器支持
68
+ | Browser | Version | Support |
69
+ | ---------------------- | ------- | :-----: |
70
+ | Google Chrome | Latest | ✅ |
71
+ | Firefox | Latest | ✅ |
72
+ | Safari | Latest | ✅ |
73
+ | Microsoft Edge | Latest | ✅ |
74
+ | Internet Explorer (IE) | All | ❌ |
72
75
 
73
- | 浏览器 | 版本 | 支持情况 |
74
- | ------------------------ | :----: | :-------: |
75
- | Google Chrome | 最新版 | ✅ 支持 |
76
- | Firefox | 最新版 | ✅ 支持 |
77
- | Safari | 最新版 | ✅ 支持 |
78
- | Microsoft Edge | 最新版 | ✅ 支持 |
79
- | 360 极速浏览器 | 最新版 | ✅ 支持 |
80
- | 各类国产浏览器的极速模式 | 最新版 | ✅ 支持 |
81
- | Internet Explorer (IE) | 所有 | ❌ 不支持 |
76
+ ## Node.js Version Support
82
77
 
83
- ## Nodejs 版本支持
78
+ Node.js 18.0.0 or above.
84
79
 
85
- Nodejs 18.0.0 及以上版本。
80
+ ## Join the Community
86
81
 
87
- ## 加入社区
82
+ We encourage users to join the Umo Editor open-source community and participate in the development and improvement of the product. Whether submitting bug reports, feature requests, or code contributions, all are valuable parts of our community.
88
83
 
89
- 我们鼓励用户加入 Umo Editor 的开源社区，共同参与到产品的开发和改进中来。无论是提交 Bug 报告、功能请求还是代码贡献，都是我们社区宝贵的一部分。
84
+ You can submit issues or suggestions via https://github.com/umodoc/editor/discussions.
90
85
 
91
- 您可以通过 [https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions) 提交问题或意见。
86
+ Or submit bug reports via https://github.com/umodoc/editor/issues.
92
87
 
93
- 或通过 [https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) 提交 Bug 报告。
88
+ ## Contribute Code
94
89
 
95
- ## 贡献代码
90
+ We welcome any form of contribution, including but not limited to submitting bug reports, feature requests, and code contributions.
96
91
 
97
- 我们欢迎任何形式的贡献，包括但不限于提交 Bug 报告、功能请求、代码贡献等。
92
+ ## Contact Us
98
93
 
99
- ## 联系我们
94
+ If you have any questions or suggestions, please contact us through the following methods. Before that, it is recommended to read this document carefully to understand how to use Umo Editor.
100
95
 
101
- 如果您有任何疑问或建议，请通过以下方式联系我们：
96
+ - Feedback: https://github.com/umodoc/editor/issues
97
+ - Community: https://github.com/umodoc/editor/discussions
98
+ - Email: [contact@umoteam.com](mailto:contact@umoteam.com)
102
99
 
103
- - 反馈：[https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) | [https://gitee.com/umodoc/editor/issues](https://gitee.com/umodoc/editor/issues)
104
- - 社区：[https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions)
105
- - 邮件：[contact@umoteam.com](mailto:contact@umoteam.com)
100
+ ## Support Us
106
101
 
107
- ## 支持我们
102
+ If you find Umo Editor useful, please consider supporting us in the following ways:
108
103
 
109
- 如果您觉得 Umo Editor 有用，请考虑通过以下方式支持我们：
104
+ - ⭐ Star the [Umo Editor Repository](https://github.com/umodoc/editor) to show your support for the project.
105
+ - 🔗 If you use Umo Editor in your project, please add a link to https://github.com/umodoc/editor.
110
106
 
111
- - ⭐ 给 [Umo Editor 仓库](https://github.com/umodoc/editor) 点个 Star，表示对项目的支持。
112
- - 🔗 如果您在项目中使用了 Umo Editor，请添加一个链接到 [https://github.com/umodoc/editor](https://github.com/umodoc/editor)。
107
+ ## Open Source License
113
108
 
114
- ## 定制开发
109
+ Umo Editor is licensed under the [MIT License](https://github.com/umodoc/editor/blob/main/LICENSE), allowing you to use, modify, and distribute the software freely.
115
110
 
116
- 如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案。
117
-
118
- ## 开源协议
119
-
120
- Umo Editor 采用 [MIT 许可证](./LICENSE)，您可以免费使用、修改和使用本软件。
111
+ This document is published under the [CC BY-NC-SA 4.0 DEED License](https://creativecommons.org/licenses/by-nc-sa/4.0).
package/README.zh-CN.md ADDED
@@ -0,0 +1,121 @@
1
+ <p style="text-align: center; margin: 2rem 0">
2
+ <a href="https://umodoc.com" target="_blank"><img src="https://unpkg.com/@umoteam/editor-external@latest/static/logo.svg" alt="umodoc.com" width="360" /></a>
3
+ </p>
4
+
5
+ <p style="text-align: center;">
6
+ <a href="https://github.com/umodoc/editor/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@umoteam/editor" /></a>
7
+ <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/v/@umoteam/editor" /></a>
8
+ <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/d18m/@umoteam/editor" /></a>
9
+ </p>
10
+
11
+ ## 基本介绍
12
+
13
+ Umo Editor 是一个基于 Vue3 适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览，支持文档块编辑，支持添加自定义扩展，支持多语言设置。
14
+
15
+ <img src="https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-cn@2x.png" alt="umo editor" />
16
+
17
+ 作为一个独立的 Vue3 插件，Umo Editor 可以零配置轻松集成到各类 Vue3 项目中，对于非 Vue3 项目，您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
18
+
19
+ ## 安装
20
+
21
+ ```bash
22
+ npm config set "@tiptap-pro:registry" https://registry.tiptap.dev/
23
+ npm config set "//registry.tiptap.dev/:_authToken" 9fsQEgp8C8pbxpk8PFAjYn64BtBDq6HfXmI2qgpnI7XYr/OwHaMvOUIE5mfVR49y
24
+ npm install --save @umoteam/editor @umoteam/editor-external
25
+ ```
26
+
27
+ 通过其他包管理器安装，如 `yarn`、`pnpm` 等，请参考 [开发文档 - 快速开始](https://editor.umodoc.com/cn/docs/getting-started)。
28
+
29
+ ## 快速开始
30
+
31
+ [开发文档](https://editor.umodoc.com/cn/docs) | [在线演示](https://demo.umodoc.com/editor?lang=cn) | [GitHub](https://github.com/umodoc/editor) | [码云(国内镜像)](https://gitee.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
32
+
33
+ ## 在线体验
34
+
35
+ 访问 [在线演示](https://demo.umodoc.com/editor?pane=no&lang=cn) 快速体验。
36
+
37
+ ## 开发文档
38
+
39
+ 请访问 [开发文档](https://editor.umodoc.com/cn/docs) 。
40
+
41
+ ## 设计理念
42
+
43
+ Umo Editor 的诞生，旨在解决 Web 应用中文档编辑的复杂性，为 Web 项目提供开源免费的类似 Office Word 的强大编辑能力和协同能力，同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理，Umo Editor 都能成为您得力的助手。
44
+
45
+ ## 开源优势
46
+
47
+ - **免费使用**：作为开源项目，Umo Editor 基于 [MIT 许可证](https://github.com/umo-editor/umo-editor/blob/main/LICENSE) 对所有开发者免费开放，无需担心版权问题。
48
+
49
+ - **持续更新**：Umo Editor 将持续迭代，不断优化功能，提升用户体验。
50
+
51
+ - **定制化开发**：开源意味着更大的灵活性，开发者可根据项目需求进行定制化开发，打造专属的文档编辑器。
52
+
53
+ ## 核心特性
54
+
55
+ - 零配置开箱即用
56
+ - 轻量级
57
+ - 全过程所见即所得
58
+ - 富文本编辑功能
59
+ - Markdown 语法支持
60
+ - 实用工具集成
61
+ - 演示模式
62
+ - 页面设置
63
+ - 文档导出与分享
64
+ - 气泡菜单与块级菜单
65
+ - 快捷键支持
66
+ - 支持打印及打印预览
67
+ - 主题定制
68
+ - 多语言设置
69
+
70
+ 更多详细介绍见 [核心特性](https://editor.umodoc.com/cn/docs/features)。
71
+
72
+ ## 浏览器支持
73
+
74
+ | 浏览器 | 版本 | 支持情况 |
75
+ | ------------------------ | :----: | :-------: |
76
+ | Google Chrome | 最新版 | ✅ 支持 |
77
+ | Firefox | 最新版 | ✅ 支持 |
78
+ | Safari | 最新版 | ✅ 支持 |
79
+ | Microsoft Edge | 最新版 | ✅ 支持 |
80
+ | 360 极速浏览器 | 最新版 | ✅ 支持 |
81
+ | 各类国产浏览器的极速模式 | 最新版 | ✅ 支持 |
82
+ | Internet Explorer (IE) | 所有 | ❌ 不支持 |
83
+
84
+ ## Nodejs 版本支持
85
+
86
+ Nodejs 18.0.0 及以上版本。
87
+
88
+ ## 加入社区
89
+
90
+ 我们鼓励用户加入 Umo Editor 的开源社区，共同参与到产品的开发和改进中来。无论是提交 Bug 报告、功能请求还是代码贡献，都是我们社区宝贵的一部分。
91
+
92
+ 您可以通过 [https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions) 提交问题或意见。
93
+
94
+ 或通过 [https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) 提交 Bug 报告。
95
+
96
+ ## 贡献代码
97
+
98
+ 我们欢迎任何形式的贡献，包括但不限于提交 Bug 报告、功能请求、代码贡献等。
99
+
100
+ ## 联系我们
101
+
102
+ 如果您有任何疑问或建议，请通过以下方式联系我们：
103
+
104
+ - 反馈：[https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) | [https://gitee.com/umodoc/editor/issues](https://gitee.com/umodoc/editor/issues)
105
+ - 社区：[https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions)
106
+ - 邮件：[contact@umoteam.com](mailto:contact@umoteam.com)
107
+
108
+ ## 支持我们
109
+
110
+ 如果您觉得 Umo Editor 有用，请考虑通过以下方式支持我们：
111
+
112
+ - ⭐ 给 [Umo Editor 仓库](https://github.com/umodoc/editor) 点个 Star，表示对项目的支持。
113
+ - 🔗 如果您在项目中使用了 Umo Editor，请添加一个链接到 [https://github.com/umodoc/editor](https://github.com/umodoc/editor)。
114
+
115
+ ## 定制开发
116
+
117
+ 如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案。
118
+
119
+ ## 开源协议
120
+
121
+ Umo Editor 采用 [MIT 许可证](./LICENSE)，您可以免费使用、修改和使用本软件。