npm - @umoteam/editor - Versions diffs - 5.0.0 → 6.0.1 - Mend

@umoteam/editor 5.0.0 → 6.0.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 (6) hide show

package/README.md +55 -50
package/README.zh-CN.md +42 -39
package/dist/style.css +1 -1
package/dist/umo-editor.js +41357 -32117
package/package.json +58 -48
package/types/index.d.ts +239 -0

package/README.md CHANGED Viewed

@@ -2,7 +2,7 @@
 <a href="https://umodoc.com" target="_blank"><img src="https://unpkg.com/@umoteam/editor-external@latest/static/logo.svg" alt="umodoc.com" width="280" /></a>
 </p>
-<p style={{ textAlign: 'center' }}>
+<p style="text-align: center;">
 <a href="https://github.com/umodoc/editor/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/npm/l/@umoteam/editor" /></a>
 <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/v/@umoteam/editor" /></a>
 <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/d18m/@umoteam/editor" /></a>
@@ -12,61 +12,61 @@
 # 中文介绍
-Umo Editor 是一个基于 Vue3 和 Tiptap 的适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力和 AI 创作能力，支持分页，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览，支持文档块编辑，支持添加自定义扩展，支持多语言设置，支持暗色主题。
+Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
-详细介绍见： [README.zh-CN.md](https://github.com/umodoc/editor/blob/main/README.zh-CN.md)
+Umo Editor 最大的特点是代码完全开源且自主可控，支持私有部署。您可以内网环境中使用，而无需担心数据安全问题。
-# Introduction
+## Introduction
-Umo Editor is open-source document editor based on Vue3 and Tiptap. Umo Editor provides comprehensive document editing capabilities and AI creation features, supports pagination, supports Markdown syntax, offers basic rich text editing functions, allows for the insertion of various node types in multiple formats, provides a variety of practical tools, and supports setting page styles. It also supports exporting in various formats, printing and print preview, block-level document editing, adding custom extensions, multi-language settings, and a dark theme.
+Umo Editor is an open-source document editor based on Vue3 and Tiptap. It provides powerful document editing capabilities and AI-assisted creation features. Umo Editor supports pagination, Markdown syntax, rich text editing, insertion of various node types, page style settings, document export, and printing. Additionally, it supports custom extensions, multi-language settings, and a dark theme.
-<img src="https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-en@2x.png" alt="umo editor" />
+Umo Editor's largest feature is that its code is completely open source and controllable. It supports private deployment, allowing you to use it in an intranet environment without worrying about data security issues.
-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.
+![Umo Editor](https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-en@2x.png)
-[Documentation](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Live Demo](https://demo.umodoc.com/editor?lang=en-US) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
+As an independent Vue3 plugin, Umo Editor can be easily integrated into various Vue3 projects with zero configuration. For non-Vue3 projects, you can embed Umo Editor into your project via an iframe.
+[Documentation](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Playground](https://demo.umodoc.com/editor?lang=en-US) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
 ## Online Experience
-Visit [Playground](https://demo.umodoc.com/editor?pane=hide&lang=en-US) for a fast experience.
+Visit [Playground](https://demo.umodoc.com/editor?pane=hide&lang=en-US) to try Umo Editor.
 ## Documentation
-Please visit [Documentation](https://editor.umodoc.com/en/docs).
+Please visit [Documentation](https://editor.umodoc.com/en/docs) for detailed instructions.
 ## Design Philosophy
-The birth of Umo Editor aims to address the complexity of document editing in web applications, providing open-source and free powerful editing capabilities and pagination modes similar to Microsoft Word for web projects, 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 your capable assistant.
+Umo Editor aims to simplify document editing in web applications by providing Microsoft Word-like powerful editing capabilities and pagination mode while maintaining the convenience of web applications. Whether for government and enterprise information management systems, academic research writing, team document collaboration, knowledge base management, or personal note organization, Umo Editor is your reliable assistant.
 ## Open Source Advantages
-- **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.
-- **Continuous Updates**: Umo Editor will continue to iterate, constantly optimizing features and enhancing user experience.
-- **Customizable Development**: Open source means greater flexibility. Developers can customize the development according to project needs to create a unique document editor.
+- **Free to Use**: Umo Editor is free for all developers under the [MIT License](https://github.com/umo-editor/umo-editor/blob/main/LICENSE), with no copyright concerns.
+- **Continuous Updates**: Umo Editor is continuously iterated to optimize features and enhance user experience.
+- **Custom Development**: Open source allows developers to customize Umo Editor to meet project-specific needs.
-## Core Features
+## Key Features
-- Zero-config out-of-the-box usability
-- Pagination mode similar to that in Microsoft Word
+- Zero configuration, ready to use
+- Pagination mode similar to Microsoft Word
 - Lightweight
-- WYSIWYG (What You See Is What You Get) throughout the process
-- Rich-text editing capabilities
+- Full WYSIWYG editing
+- Rich text editing
 - Markdown syntax support
 - Integrated practical tools
 - Presentation mode
 - Document export and sharing
 - Page settings
-- AI assistant
-- Support for printing and print preview
-- Support for custom plugins
+- AI document assistant
+- Print and print preview support
+- Custom extensions support
 - Shortcut key support
 - Theme customization
-- Multi-language settings
-- Dark mode support
+- Multilingual settings
+- Dark mode
-For more detailed introductions, see [Core Features](./docs/features).
+For more details, see [Features](https://editor.umodoc.com/en/docs/features).
 ## Browser Support
@@ -78,49 +78,54 @@ For more detailed introductions, see [Core Features](./docs/features).
 | Microsoft Edge         | Latest  |   ✅    |
 | Internet Explorer (IE) | All     |   ❌    |
-## Node.js Version Support
+## Environment Support
-Node.js 18.0.0 or above.
+- **Node.js** (>=v18.0.0)
+- **Vue** (>=v3.x)
+- **Vite** (>=v4.x)
+- **Tiptap** (>=v2.6)
+- **TypeScript** (>=v5.5)
 ## Join the Community
-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.
+We encourage users to join the Umo Editor open-source community and participate in the development and improvement of the product. Whether it's submitting bug reports, feature requests, or code contributions, your involvement is invaluable to our community.
-You can submit issues or suggestions via https://github.com/umodoc/editor/discussions.
+Submit issues or suggestions via [GitHub Discussions](https://github.com/umodoc/editor/discussions).
-Or submit bug reports via https://github.com/umodoc/editor/issues.
+Report bugs via [GitHub Issues](https://github.com/umodoc/editor/issues).
-## Contributing Code
+## Contribute Code
-### Contributors
-The development of Umo Editor could not have been possible without the support of the community. Below is the list of contributors who have contributed code to Umo Editor. We extend our thanks to them:
+The development of Umo Editor relies on community support. Below is a list of contributors who have contributed code to Umo Editor. We thank them for their efforts:
 - [Umo Team](https://github.com/umodoc): 👨‍💻 Core developers
-- [Cassielxd](https://github.com/Cassielxd): 💪🏻 Implemented pagination and many important features for Umo Editor
-- [Na'aman Hirschfeld](https://github.com/Goldziher): 💪🏻 Enhanced TypeScript support, added tests, and provided a stronger foundation for Umo Editor's development
-- [SerRashin](https://github.com/SerRashin): 🛠️ Added Russian language support for Umo Editor
-- [ChenErik](https://github.com/ChenErik): 🛠️ Contributed code to Umo Editor
-- [china-wangxu](https://github.com/china-wangxu): 🛠️ Contributed code to Umo Editor
-- [Sherman Xu](https://github.com/xuzhenjun130): 🛠️ Contributed code to Umo Editor
+- [Cassielxd](https://github.com/Cassielxd): 💪🏻 Implemented pagination and many important features
+- [china-wangxu](https://github.com/china-wangxu): 💪🏻 Added many important features
+- [Na'aman Hirschfeld](https://github.com/Goldziher): 💪🏻 Enhanced TypeScript support and added tests
+- [ChenErik](https://github.com/ChenErik): 🛠️ Contributed code
+- [SerRashin](https://github.com/SerRashin): 🛠️ Added Russian language support
+- [Sunny Wisozk](https://github.com/SunnyWisozk): 🛠️ Contributed code
+- [Sherman Xu](https://github.com/xuzhenjun130): 🛠️ Contributed code
 We welcome all forms of contributions, including but not limited to submitting bug reports, feature requests, and code contributions.
 ## Contact Us
-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.
+If you have any questions or suggestions, please contact us through the following channels. Before doing so, we recommend reading this documentation thoroughly to understand how to use Umo Editor.
-- Feedback: https://github.com/umodoc/editor/issues
-- Community: https://github.com/umodoc/editor/discussions
-- Email: [contact@umoteam.com](mailto:contact@umoteam.com)
+- Feedback: [GitHub Issues](https://github.com/umodoc/editor/issues)
+- Community: [GitHub Discussions](https://github.com/umodoc/editor/discussions)
+- Email: [contact@umodoc.com](mailto:contact@umodoc.com)
 ## Support Us
 If you find Umo Editor useful, please consider supporting us in the following ways:
-- ⭐ Star the [Umo Editor Repository](https://github.com/umodoc/editor) to show your support for the project.
-- 🔗 If you use Umo Editor in your project, please add a link to https://github.com/umodoc/editor.
+- ⭐ Star the [Umo Editor repository](https://github.com/umodoc/editor) to show your support.
+- 🔗 If you use Umo Editor in your project, add a link to https://github.com/umodoc/editor.
+## Open Source License
-## License
+Umo Editor is licensed under the [MIT License](./LICENSE). You are free to use, modify, and distribute this software, but this does **not** mean you are allowed to remove the copyright information at will. Please retain the Umo Editor copyright notice and the link displayed in the interface. Removal of these will be considered an infringement. We encourage you to support open-source projects.
-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.
+If you do not wish to retain the copyright information, please contact us or consider purchasing the commercial version: [Umo Editor Next](https://editor.umodoc.com/cn/docs/next).

package/README.zh-CN.md CHANGED Viewed

@@ -12,57 +12,55 @@
 ## 基本介绍
-Umo Editor 是一个基于 Vue3 和 Tiptap 的适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力和 AI 创作能力，支持分页，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览，支持文档块编辑，支持添加自定义扩展，支持多语言设置，支持暗色主题。
+Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
-<img src="https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-cn@2x.png" alt="umo editor" />
+Umo Editor 最大的特点是代码完全开源且自主可控，支持私有部署。您可以内网环境中使用，而无需担心数据安全问题。
-作为一个独立的 Vue3 插件，Umo Editor 可以零配置轻松集成到各类 Vue3 项目中，对于非 Vue3 项目，您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
+![Umo Editor](https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-cn@2x.png)
-## 快速开始
+作为一个独立的 Vue3 插件，Umo Editor 可以轻松集成到各类 Vue3 项目中。对于非 Vue3 项目，您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
 [开发文档](https://editor.umodoc.com/cn/docs) | [在线演示](https://demo.umodoc.com/editor?lang=zh-CN) | [GitHub](https://github.com/umodoc/editor) | [码云(国内镜像)](https://gitee.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
 ## 在线体验
-访问 [在线演示](https://demo.umodoc.com/editor?pane=hide&lang=zh-CN) 快速体验。
+访问[https://demo.umodoc.com/editor?pane=hide](https://demo.umodoc.com/editor?pane=hide)快速体验。
 ## 开发文档
-请访问 [开发文档](https://editor.umodoc.com/cn/docs) 。
+请访问[https://editor.umodoc.com/cn/docs](https://editor.umodoc.com/cn/docs)。
 ## 设计理念
-Umo Editor 的诞生，旨在解决 Web 应用中文档编辑的复杂性，为 Web 项目提供开源免费的类似 Microsoft Word 的强大编辑能力和分页模式，同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理，Umo Editor 都能成为您得力的助手。
+Umo Editor 的诞生旨在解决 Web 应用中文档编辑的复杂性，为 Web 项目提供类似 Microsoft Word 的强大编辑能力，同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理，Umo Editor 都能成为您的得力助手。
 ## 开源优势
-- **免费使用**：作为开源项目，Umo Editor 基于 [MIT 许可证](https://github.com/umo-editor/umo-editor/blob/main/LICENSE) 对所有开发者免费开放，无需担心版权问题。
+- **免费使用**：Umo Editor 基于[MIT 许可证](https://github.com/umo-editor/umo-editor/blob/main/LICENSE)对所有开发者免费开放，无需担心版权问题。
 - **持续更新**：Umo Editor 将持续迭代，不断优化功能，提升用户体验。
 - **定制化开发**：开源意味着更大的灵活性，开发者可根据项目需求进行定制化开发，打造专属的文档编辑器。
 ## 核心特性
 - 零配置开箱即用
-- 类似于与 Microsoft Word 的分页模式
+- 类似 Microsoft Word 的分页模式
 - 轻量级
-- 全过程所见即所得
+- 所见即所得
 - 富文本编辑功能
 - Markdown 语法支持
 - 实用工具集成
 - 演示模式
+- 文档导出与分享
 - 页面设置
 - AI 文档助手
-- 文档导出与分享
-- 气泡菜单与块级菜单
-- 快捷键支持
 - 支持打印及打印预览
+- 支持自定义扩展
+- 快捷键支持
 - 主题定制
 - 多语言设置
 - 暗色主题
-更多详细介绍见 [核心特性](https://editor.umodoc.com/cn/docs/features)。
+更多详细介绍见[核心特性](https://editor.umodoc.com/cn/docs/features)。
 ## 浏览器支持
@@ -76,43 +74,46 @@ Umo Editor 的诞生，旨在解决 Web 应用中文档编辑的复杂性，为
 | 各类国产浏览器的极速模式 | 最新版 |  ✅ 支持  |
 | Internet Explorer (IE)   |  所有  | ❌ 不支持 |
-## Nodejs 版本支持
+## 环境支持
-Nodejs 18.0.0 及以上版本。
+- **Node.js** (>=v18.0.0)
+- **Vue** (>=v3.x)
+- **Vite** (>=v4.x)
+- **Tiptap** (>=v2.6)
+- **TypeScript** (>=v5.5)
 ## 加入社区
-我们鼓励用户加入 Umo Editor 的开源社区，共同参与到产品的开发和改进中来。无论是提交 Bug 报告、功能请求还是代码贡献，都是我们社区宝贵的一部分。
+我们鼓励用户加入 Umo Editor 的开源社区，共同参与到产品的开发和改进中。无论是提交 Bug 报告、功能请求还是代码贡献，都是我们社区宝贵的一部分。
-您可以通过 [https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions) 提交问题或意见。
+您可以通过 [GitHub Discussions](https://github.com/umodoc/editor/discussions) 提交问题或意见。
-或通过 [https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) 提交 Bug 报告。
+或通过 [GitHub Issues](https://github.com/umodoc/editor/issues) 提交 Bug 报告。
 ## 贡献代码
-### 贡献者名单
-Umo Editor 的发展，离不开社区的支持，以下是为 Umo Editor 贡献过代码的贡献者名单，向他们致谢：
+Umo Editor 的发展离不开社区的支持，以下是为 Umo Editor 贡献过代码的贡献者名单，向他们致谢：
 - [Umo Team](https://github.com/umodoc)：👨‍💻 核心开发者
-- [Cassielxd](https://github.com/Cassielxd)：💪🏻 为 Umo Editor 实现了分页和很多重要的功能
-- [Na'aman Hirschfeld](https://github.com/Goldziher)：💪🏻 增强对 TypeScript 的支持，添加测试，为 Umo Editor 的发展提供更好的基础
-- [SerRashin](https://github.com/SerRashin): 🛠️ 为 Umo Editor 添加了俄语支持
-- [ChenErik](https://github.com/ChenErik): 🛠️ 为 Umo Editor 贡献了部分代码
-- [china-wangxu](https://github.com/china-wangxu): 🛠️ 为 Umo Editor 贡献了部分代码
-- [Sherman Xu](https://github.com/xuzhenjun130): 🛠️ 为 Umo Editor 贡献了部分代码
+- [Cassielxd](https://github.com/Cassielxd)：💪🏻 实现了分页和许多重要功能
+- [china-wangxu](https://github.com/china-wangxu)：💪🏻 添加了许多重要功能
+- [Na'aman Hirschfeld](https://github.com/Goldziher)：💪🏻 增强了 TypeScript 支持并添加测试
+- [ChenErik](https://github.com/ChenErik)：🛠️ 贡献了部分代码
+- [SerRashin](https://github.com/SerRashin)：🛠️ 添加了俄语支持
+- [Sunny Wisozk](https://github.com/SunnyWisozk)：🛠️ 贡献了部分代码
+- [Sherman Xu](https://github.com/xuzhenjun130)：🛠️ 贡献了部分代码
 我们欢迎任何形式的贡献，包括但不限于提交 Bug 报告、功能请求、代码贡献等。
 ## 联系我们
-如果您有任何疑问或建议，请通过以下方式联系我们：
+如果您有任何疑问或建议，请通过以下方式联系我们。在此之前，建议您详细阅读本文档，以便了解如何使用 Umo Editor。
-- 反馈：[https://github.com/umodoc/editor/issues](https://github.com/umodoc/editor/issues) | [https://gitee.com/umodoc/editor/issues](https://gitee.com/umodoc/editor/issues)
-- 社区：[https://github.com/umodoc/editor/discussions](https://github.com/umodoc/editor/discussions)
-- 邮件：[contact@umoteam.com](mailto:contact@umoteam.com)
+- 反馈：[GitHub Issues](https://github.com/umodoc/editor/issues)
+- 社区：[GitHub Discussions](https://github.com/umodoc/editor/discussions)
+- 邮件：[contact@umodoc.com](mailto:contact@umodoc.com)
-## QQ 技术交流群：
+## QQ 技术交流群
 - [Umo Editor 技术交流1群：994500039](https://qm.qq.com/cgi-bin/qm/qr?k=BH_TYEK3Om0BkN4VMT9TQLRvHzEhkUvp&jump_from=webapi&authKey=xIMvInBso7hjJHh8+44+8IMHhLjvpegQJC0wFtZRir76+vgrBFcw98FVoqCxV7XX)
@@ -120,13 +121,15 @@ Umo Editor 的发展，离不开社区的支持，以下是为 Umo Editor 贡献
 如果您觉得 Umo Editor 有用，请考虑通过以下方式支持我们：
-- ⭐ 给 [Umo Editor 仓库](https://github.com/umodoc/editor) 点个 Star，表示对项目的支持。
-- 🔗 如果您在项目中使用了 Umo Editor，请添加一个链接到 [https://github.com/umodoc/editor](https://github.com/umodoc/editor)。
+- ⭐ 给[Umo Editor 仓库](https://github.com/umodoc/editor)点个 Star，表示对项目的支持。
+- 🔗 如果您在项目中使用了 Umo Editor，请添加一个链接到 https://github.com/umodoc/editor 。
 ## 定制开发
-如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案。
+如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案和商业支持。详细信息请访问[定制开发](https://editor.umodoc.com/cn/docs/customization)。
 ## 开源协议
-Umo Editor 采用 [MIT 许可证](./LICENSE)，您可以免费使用、修改和使用本软件。
+Umo Editor 采用 [MIT 许可证](./LICENSE)，您可以免费使用、修改和使用本软件，但这不代表您可以随意删除版权信息，请保留 Umo Editor 的版权信息和界面上的链接地址，否则视为侵权，请支持开源项目。
+如果您不想保留版权信息，请联系我们或者购买商业版本 [Umo Editor Next](https://editor.umodoc.com/cn/docs/next)。