@umoteam/editor 7.0.1 → 8.1.0

package/README.md

@@ -1,5 +1,5 @@
 <p style="text-align: center; margin: 2rem 0;">
-<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>
+<a href="https://www.umodoc.com/en" target="_blank"><img src="https://unpkg.com/@umoteam/editor-external@latest/static/logo.svg" alt="umodoc.com" width="280" /></a>
 </p>
 
 <p style="text-align: center;">
@@ -10,15 +10,21 @@
 <a href="https://github.com/umodoc/editor/commits" target="_blank"><img src="https://img.shields.io/github/commit-activity/m/umodoc/editor" /></a>
 </p>
 
-# 中文介绍
+<p style="text-align: center;">English Documentation | <a href="https://dev.umodoc.com/cn/docs/editor">[中文文档]</a></p>
 
-Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
+## 中文介绍
+
+Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式和普通 Web 模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。
+
+此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。同时我们提供了单独的文本预览组件 [Umo Viewer](https://github.com/umodoc/viewer)，用户可以在项目中使用该组件来预览文档。
 
 Umo Editor 最大的特点是代码完全开源且自主可控，支持私有部署，您可以内网环境中使用，而无需担心数据安全问题。同时 Umo Editor 基于 Vue3 和 Tiptap，两者都有丰富的生态系统和社区支持，在遇到问题时可以迅速得到解决。
 
 ## Introduction
 
-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.
+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 and normal web layout, 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. Umo Editor also supports web layout, and you can use it as a regular rich text editor.
+
+Additionally, Umo Editor supports custom extensions, multi-language settings, and dark theme. We also provide a standalone text preview component, [Umo Viewer](https://github.com/umodoc/viewer), which users can integrate into their projects to preview documents.
 
 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. At the same time, Umo Editor is based on Vue3 and Tiptap, both of which have rich ecosystems and communities, making it easy to solve problems when needed.
 
@@ -26,15 +32,15 @@ Umo Editor's largest feature is that its code is completely open source and cont
 
 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.
 
-[Website](https://umodoc.com/en) | [Documentation](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Playground](https://umodoc.com/en/demo) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
+[Website](https://www.umodoc.com/en) | [Documentation](https://dev.umodoc.com/en/docs/editor) | [Playground](https://www.umodoc.com/en/demo) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
 
 ## Online Experience
 
-Visit [Playground](https://umodoc.com/en/demo) to try Umo Editor.
+Visit [Playground](https://www.umodoc.com/en/demo?pane=hide) to try Umo Editor.
 
 ## Documentation
 
-Please visit [Documentation](https://editor.umodoc.com/en/docs) for detailed instructions.
+Please visit [Documentation](https://dev.umodoc.com/en/docs/editor) for detailed instructions.
 
 ## Design Philosophy
 
@@ -48,6 +54,7 @@ Umo Editor aims to simplify document editing in web applications by providing Mi
 
 ## Key Features
 
+- Support for Intranet Deployment
 - Zero configuration, ready to use
 - Pagination mode similar to Microsoft Word
 - Lightweight
@@ -65,8 +72,10 @@ Umo Editor aims to simplify document editing in web applications by providing Mi
 - Theme customization
 - Multilingual settings
 - Dark mode
+- Support for Web layout
+- Standalone document preview component [Umo Viewer](https://github.com/umodoc/viewer)
 
-For more details, see [Features](https://editor.umodoc.com/en/docs/features).
+For more details, see [Features](https://dev.umodoc.com/en/docs/editor/features).
 
 ## Browser Support
 
@@ -82,7 +91,7 @@ For more details, see [Features](https://editor.umodoc.com/en/docs/features).
 
 - **Node.js** (>=v18.0.0)
 - **Vue** (>=v3.x)
-- **Vite** (>=v4.x)
+- **Vite** (>=v5.x)
 - **Tiptap** (>=v2.6)
 - **TypeScript** (>=v5.5)
 
@@ -102,10 +111,13 @@ The development of Umo Editor relies on community support. Below is a list of co
 - [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
+- [SevenDreamYang](https://github.com/SevenDreamYang)：🛠️ Enhanced TypeScript support
 - [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
+- [vace](https://github.com/vace)：🛠️ Contributed code
+- [Mikasa33](https://github.com/Mikasa33)：🛠️ Contributed code
 
 We welcome all forms of contributions, including but not limited to submitting bug reports, feature requests, and code contributions.
 
@@ -128,17 +140,10 @@ If you find Umo Editor useful, please consider supporting us in the following wa
 - ⭐ 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 Ecosystem
-
-Here are some open source projects that use Umo Editor:
-
-- [文章转知识卡片](https://www.wordtocard.com/)
-- [Umo Editor 分页](https://github.com/Cassielxd/umo-enhance)
-
-If you are using Umo Editor and would like to be featured here, please let us know via email at [contact@umodoc.com](mailto:contact@umodoc.com).
-
 ## Open Source 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/raw/main/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.
+
+If you do not wish to retain the copyright information, please contact us or consider purchasing the commercial version: [Umo Editor Next](https://dev.umodoc.com/en/docs/editor/next).
 
-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/en/docs/next).
+This documentation is published under the [CC BY-NC-SA 4.0 DEED License](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en).

package/README.zh-CN.md

@@ -1,5 +1,5 @@
 <p style="text-align: center; margin: 2rem 0;">
-<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>
+<a href="https://www.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="text-align: center;">
@@ -9,26 +9,29 @@
 <a href="https://www.npmjs.com/package/@umoteam/editor" target="_blank"><img src="https://img.shields.io/npm/unpacked-size/%40umoteam%2Feditor" /></a>
 <a href="https://github.com/umodoc/editor/commits" target="_blank"><img src="https://img.shields.io/github/commit-activity/m/umodoc/editor" /></a>
 </p>
+<p style="text-align: center;"><a href="https://dev.umodoc.com/en/docs/editor">[English Documentation]</a> | 中文文档</p>
 
 ## 基本介绍
 
-Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。
+Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式和普通 Web 模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。
+
+此外，Umo Editor 还支持自定义扩展、多语言设置和暗色主题。同时我们提供了单独的文本预览组件[Umo Viewer](https://github.com/umodoc/viewer)，用户可以在项目中使用该组件来预览文档。
 
 Umo Editor 最大的特点是代码完全开源且自主可控，支持私有部署，您可以内网环境中使用，而无需担心数据安全问题。同时 Umo Editor 基于 Vue3 和 Tiptap，两者都有丰富的生态系统和社区支持，在遇到问题时可以迅速得到解决。
 
-![Umo Editor](https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-cn@2x.png)
+![Umo Editor](https://unpkg.com/@umoteam/editor-external@latest/static/umo-editor-cn@2x.pngg)
 
 作为一个独立的 Vue3 插件，Umo Editor 可以轻松集成到各类 Vue3 项目中。对于非 Vue3 项目，您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
 
-[官网](https://umodoc.com) | [开发文档](https://editor.umodoc.com/cn/docs) | [在线演示](https://umodoc.com/demo) | [GitHub](https://github.com/umodoc/editor) | [码云(国内镜像)](https://gitee.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
+[官网](https://www.umodoc.com) | [开发文档](https://dev.umodoc.com/cn/docs/editor) | [在线演示](https://www.umodoc.com/demo) | [GitHub](https://github.com/umodoc/editor) | [码云(国内镜像)](https://gitee.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)
 
 ## 在线体验
 
-访问[https://umodoc.com/demo](https://umodoc.com/demo)快速体验。
+访问[https://www.umodoc.com/demo?pane=hide](https://www.umodoc.com/demo?pane=hide)快速体验。
 
 ## 开发文档
 
-请访问[https://editor.umodoc.com/cn/docs](https://editor.umodoc.com/cn/docs)。
+请访问[https://dev.umodoc.com/cn/docs/editor](https://dev.umodoc.com/cn/docs/editor)。
 
 ## 设计理念
 
@@ -42,6 +45,7 @@ Umo Editor 的诞生旨在解决 Web 应用中文档编辑的复杂性，为 Web
 
 ## 核心特性
 
+- 支持内网部署
 - 零配置开箱即用
 - 类似 Microsoft Word 的分页模式
 - 轻量级
@@ -59,8 +63,10 @@ Umo Editor 的诞生旨在解决 Web 应用中文档编辑的复杂性，为 Web
 - 主题定制
 - 多语言设置
 - 暗色主题
+- 支持 Web 版式
+- 单独的文档预览组件[Umo Viewer](https://github.com/umodoc/viewer)
 
-更多详细介绍见[核心特性](https://editor.umodoc.com/cn/docs/features)。
+更多详细介绍见[核心特性](https://dev.umodoc.com/cn/docs/editor/features)。
 
 ## 浏览器支持
 
@@ -78,7 +84,7 @@ Umo Editor 的诞生旨在解决 Web 应用中文档编辑的复杂性，为 Web
 
 - **Node.js** (>=v18.0.0)
 - **Vue** (>=v3.x)
-- **Vite** (>=v4.x)
+- **Vite** (>=v5.x)
 - **Tiptap** (>=v2.6)
 - **TypeScript** (>=v5.5)
 
@@ -98,10 +104,13 @@ Umo Editor 的发展离不开社区的支持，以下是为 Umo Editor 贡献过
 - [Cassielxd](https://github.com/Cassielxd)：💪🏻 实现了分页和许多重要功能
 - [china-wangxu](https://github.com/china-wangxu)：💪🏻 添加了许多重要功能
 - [Na'aman Hirschfeld](https://github.com/Goldziher)：💪🏻 增强了 TypeScript 支持并添加测试
+- [SevenDreamYang](https://github.com/SevenDreamYang)：🛠️ 增强 TypeScript 支持
 - [ChenErik](https://github.com/ChenErik)：🛠️ 贡献了部分代码
 - [SerRashin](https://github.com/SerRashin)：🛠️ 添加了俄语支持
 - [Sunny Wisozk](https://github.com/SunnyWisozk)：🛠️ 贡献了部分代码
 - [Sherman Xu](https://github.com/xuzhenjun130)：🛠️ 贡献了部分代码
+- [vace](https://github.com/vace)：🛠️ 贡献了部分代码
+- [Mikasa33](https://github.com/Mikasa33)：🛠️ 贡献了部分代码
 
 我们欢迎任何形式的贡献，包括但不限于提交 Bug 报告、功能请求、代码贡献等。
 
@@ -127,19 +136,12 @@ Umo Editor 的发展离不开社区的支持，以下是为 Umo Editor 贡献过
 
 ## 定制开发
 
-如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案和商业支持。详细信息请访问[定制开发](https://editor.umodoc.com/cn/docs/customization)。
-
-## 开源生态
-
-以下是一些开源项目，他们在开源项目中使用了 Umo Editor：
-
-- [文章转知识卡片](https://www.wordtocard.com/)
-- [Umo Editor 分页](https://github.com/Cassielxd/umo-enhance)
-
-如果您正在使用 Umo Editor，也想出现在这里，请通过邮件[contact@umodoc.com](mailto:contact@umodoc.com)告知我们。
+如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案和商业支持。详细信息请访问[定制开发](https://dev.umodoc.com/cn/docs/editor/customization)。
 
 ## 开源协议
 
-Umo Editor 采用 [MIT 许可证](./LICENSE)，您可以免费使用、修改和使用本软件，但这不代表您可以随意删除版权信息，请保留 Umo Editor 的版权信息和界面上的链接地址，否则视为侵权，请支持开源项目。
+Umo Editor 采用 [MIT 许可证](https://gitee.com/umodoc/editor/raw/main/LICENSE)，您可以免费使用、修改和使用本软件，但这不代表您可以随意删除版权信息，请保留 Umo Editor 的版权信息和界面上的链接地址，否则视为侵权，请支持开源项目。
+
+如果您不想保留版权信息，请联系我们或者购买商业版本 [Umo Editor Next](https://dev.umodoc.com/cn/docs/editor/next)。
 
-如果您不想保留版权信息，请联系我们或者购买商业版本 [Umo Editor Next](https://editor.umodoc.com/cn/docs/next)。
+本文档采用[CC BY-NC-SA 4.0 DEED 许可证](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh-hans)发布。