基本介绍
Umo Editor 是一个基于 Vue3 和 Tiptap 的适合于国人使用的本土化开源文档编辑器。Umo Editor 提供完善的文档编辑能力和 AI 创作能力,支持分页,支持 Markdown 语法,支持基础的富文本编辑功能,支持多种插入多种格式的节点类型、提供了多种类型的实用工具,并支持设置页面的样式,支持导出多种类型的格式,支持打印和打印预览,支持文档块编辑,支持添加自定义扩展,支持多语言设置,支持暗色主题。
作为一个独立的 Vue3 插件,Umo Editor 可以零配置轻松集成到各类 Vue3 项目中,对于非 Vue3 项目,您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。
Developer Documentation | 开发文档 | 在线演示 | GitHub | 码云(国内镜像) | NPM
在线体验
访问https://demo.umodoc.com/editor?pane=hide快速体验。
开发文档
请访问https://editor.umodoc.com/cn/docs。
设计理念
Umo Editor 的诞生,旨在解决 Web 应用中文档编辑的复杂性,为 Web 项目提供开源免费的类似 Microsoft Word 的强大编辑能力和分页模式,同时保持 Web 应用的便捷性。无论是政企信息管理系统、学术研究撰写、团队文档协作、知识库管理还是个人笔记整理,Umo Editor 都能成为您得力的助手。
开源优势
-
免费使用:作为开源项目,Umo Editor 基于MIT 许可证对所有开发者免费开放,无需担心版权问题。
-
持续更新:Umo Editor 将持续迭代,不断优化功能,提升用户体验。
-
定制化开发:开源意味着更大的灵活性,开发者可根据项目需求进行定制化开发,打造专属的文档编辑器。
核心特性
- 零配置开箱即用
- 类似于与 Microsoft Word 的分页模式
- 轻量级
- 全过程所见即所得
- 富文本编辑功能
- Markdown 语法支持
- 实用工具集成
- 演示模式
- 文档导出与分享
- 页面设置
- AI 文档助手
- 支持打印及打印预览
- 支持自定义插件
- 快捷键支持
- 主题定制
- 多语言设置
- 暗色主题
更多详细介绍见核心特性。
浏览器支持
浏览器 | 版本 | 支持情况 |
---|---|---|
Google Chrome | 最新版 | ✅ 支持 |
Firefox | 最新版 | ✅ 支持 |
Safari | 最新版 | ✅ 支持 |
Microsoft Edge | 最新版 | ✅ 支持 |
360 极速浏览器 | 最新版 | ✅ 支持 |
各类国产浏览器的极速模式 | 最新版 | ✅ 支持 |
Internet Explorer (IE) | 所有 | ❌ 不支持 |
Nodejs 版本支持
Nodejs 18.0.0 及以上版本。
加入社区
我们鼓励用户加入 Umo Editor 的开源社区,共同参与到产品的开发和改进中来。无论是提交 Bug 报告、功能请求还是代码贡献,都是我们社区宝贵的一部分。
您可以通过 https://github.com/umodoc/editor/discussions 提交问题或意见。
或通过 https://github.com/umodoc/editor/issues 提交 Bug 报告。
贡献代码
贡献者名单
Umo Editor 的发展,离不开社区的支持,以下是为 Umo Editor 贡献过代码的贡献者名单,向他们致谢:
- Umo Team:👨💻 核心开发者
- Cassielxd:💪🏻 为 Umo Editor 实现了分页和很多重要的功能
- Na’aman Hirschfeld:💪🏻 增强对 TypeScript 的支持,添加测试,为 Umo Editor 的发展提供更好的基础
- Sunny Wisozk:🛠️ 为 Umo Editor 贡献了部分代码
- Sherman Xu:🛠️ 为 Umo Editor 贡献了部分代码
我们欢迎任何形式的贡献,包括但不限于提交 Bug 报告、功能请求、代码贡献等。
联系我们
如果您有任何疑问或建议,请通过以下方式联系我们,在此之前,建议您详细阅读本文档,以便您了解如何使用 Umo Editor。
- 反馈:https://github.com/umodoc/editor/issues | https://gitee.com/umodoc/editor/issues
- 社区:https://github.com/umodoc/editor/discussions
- 邮件:[email protected]
QQ 技术交流群:
支持我们
如果您觉得 Umo Editor 有用,请考虑通过以下方式支持我们:
- ⭐ 给Umo Editor 仓库点个 Star,表示对项目的支持。
- 🔗 如果您在项目中使用了 Umo Editor,请添加一个链接到 https://github.com/umodoc/editor 。
定制开发
如果您需要定制化开发,请联系我们,我们可以提供付费的定制化解决方案和商业支持。
开源协议
Umo Editor 采用MIT 许可证,您可以免费使用、修改和使用本软件。
本文档采用CC BY-NC-SA 4.0 DEED 许可证发布。