@umoteam/editor

中文介绍

Umo Editor 是一个基于 Vue3 适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式，支持打印和打印预览，支持文档块编辑，支持添加自定义扩展，支持多语言设置，支持暗色主题。

详细介绍见： README.zh-CN.md

Introduction

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, i18n settings, and dark mode support.

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.

Documentation | 中文文档 | Live Demo | GitHub | NPM

Online Experience

Visit Playground for a fast experience.

Installation

npm config set "@tiptap-pro:registry" https://registry.tiptap.dev/
npm config set "//registry.tiptap.dev/:_authToken" 9fsQEgp8C8pbxpk8PFAjYn64BtBDq6HfXmI2qgpnI7XYr/OwHaMvOUIE5mfVR49y
npm install --save @umoteam/editor @umoteam/editor-external

For more information, please visit the Developer Documentation.

Documentation

Please visit Documentation.

Design Philosophy

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.

Open Source Advantages

• Free to Use: As an open-source project, Umo Editor is freely available to all developers under the MIT 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.

Core Features

• Zero-config out-of-the-box usability
• Lightweight
• WYSIWYG (What You See Is What You Get) throughout the process
• Rich-text editing capabilities
• Markdown syntax support
• Integrated practical tools
• Presentation mode
• Document export and sharing
• Page settings
• Support for printing and print preview
• Support for custom plugins
• Shortcut key support
• Theme customization
• Multi-language settings
• Dark mode support

For more detailed introductions, see Core Features.

Browser Support

Browser	Version	Support
Google Chrome	Latest	✅
Firefox	Latest	✅
Safari	Latest	✅
Microsoft Edge	Latest	✅
Internet Explorer (IE)	All	❌

Node.js Version Support

Node.js 18.0.0 or above.

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.

You can submit issues or suggestions via https://github.com/umodoc/editor/discussions.

Or submit bug reports via https://github.com/umodoc/editor/issues.

Contribute Code

We welcome any form of contribution, 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.

• Feedback: https://github.com/umodoc/editor/issues
• Community: https://github.com/umodoc/editor/discussions
• Email: [e-mail]

Support Us

If you find Umo Editor useful, please consider supporting us in the following ways:

• ⭐ Star the Umo Editor Repository 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.

Open Source License

Umo Editor is licensed under the MIT License, allowing you to use, modify, and distribute the software freely.

This document is published under the CC BY-NC-SA 4.0 DEED License.