@umoteam/editor

基本介绍

Umo Editor 是一个基于 Tiptap 无头编辑器 的 Vue3 适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持多种插入多种格式的节点类型、提供了多种类型的实用工具，并支持设置页面的样式，支持导出多种类型的格式。

作为一个独立的 Vue3 插件，Umo Editor 可以轻松集成到各类 Vue3 项目中，无需复杂配置。

开发文档 | 在线演示 | GitHub | 码云(国内镜像) | NPM

在线体验

访问 在线演示 快速体验。

开发文档

请访问 开发文档 。

设计理念

Umo Editor 的诞生，旨在解决 Web 应用中文档编辑的复杂性，为 Web 项目提供开源免费的类似 Office Word 的强大编辑能力和协同能力，同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理，Umo Editor 都能成为您得力的助手。

开源优势

免费使用：作为开源项目，Umo Editor 基于 MIT 许可证 对所有开发者免费开放，无需担心版权问题。

持续更新：Umo Editor 将持续迭代，不断优化功能，提升用户体验。

定制化开发：开源意味着更大的灵活性，开发者可根据项目需求进行定制化开发，打造专属的文档编辑器。

核心特性

Markdown 支持：轻松编写，快速预览，Umo Editor 完美兼容 Markdown 语法，让文档撰写更加高效，当然您也可以禁用 Markdown 语法。

富文本编辑：提供基础的富文本编辑功能，包含几乎所有的富文本编辑功能，如标题、段落、列表、待办事项等，满足日常编辑需求。

多样化节点类型：支持插入多种格式的节点类型，如图片、表格、代码块、富媒体、文件、特殊符号、Emoji、数学公式、文本框、模板、网页等等多种类型的内容节点类型。

实用工具集成：内置多种实用工具，如二维码、条形码、电子签名、电子签章、流程图、Mermaid 图表、中英文大小写转换、拼写检查、字数统计等，提升编辑效率。

页面样式定制：允许用户根据个人喜好和业务需求，自定义页面样式，满足个性化编辑环境。

多格式导出：支持将文档导出为多种格式，方便文档分享与存档。

浏览器支持

浏览器	版本	支持情况
Chrome	最新版	✅
Firefox	最新版	✅
Safari	最新版	✅
Edge	最新版	✅
360 极速浏览器	最新版	✅
各类国产浏览器的极速模式	最新版	✅
IE	所有	❌

加入社区

我们鼓励用户加入 Umo Editor 的开源社区，共同参与到产品的开发和改进中来。无论是提交 Bug 报告、功能请求还是代码贡献，都是我们社区宝贵的一部分。

您可以通过 https://github.com/umodoc/editor/discussions 提交问题或意见。

或通过 https://github.com/umodoc/editor/issues 提交 Bug 报告。

贡献代码

我们欢迎任何形式的贡献，包括但不限于提交 Bug 报告、功能请求、代码贡献等。

联系我们

如果您有任何疑问或建议，请通过以下方式联系我们：

• 反馈：https://github.com/umodoc/editor/issues | https://gitee.com/umodoc/editor/issues
• 社区：https://github.com/umodoc/editor/discussions
• 邮件：[e-mail]

支持我们

如果您觉得 Umo Editor 有用，请考虑通过以下方式支持我们：

• ⭐ 给 Umo Editor 仓库 点个 Star，表示对项目的支持。
• 🔗 如果您在项目中使用了 Umo Editor，请添加一个链接到 https://github.com/umodoc/editor。

定制开发

如果您需要定制化开发，请联系我们，我们可以提供付费的定制化解决方案。

开源协议

Umo Editor 采用 MIT 许可证，您可以免费使用、修改和使用本软件。

本文档采用 CC BY-NC-SA 4.0 DEED 许可证 发布。