Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 6.45 KB

README.zh-CN.md

File metadata and controls

127 lines (86 loc) · 6.45 KB

umodoc.com

基本介绍

Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器,专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能,支持分页模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。此外,Umo Editor 还支持自定义扩展、多语言设置和暗色主题。

umo editor

作为一个独立的 Vue3 插件,Umo Editor 可以轻松集成到各类 Vue3 项目中。对于非 Vue3 项目,您可以通过 Iframe 将 Umo Editor 嵌入到您的项目中。

开发文档 | 在线演示 | 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) 所有 ❌ 不支持

Node.js 版本支持

Node.js 18.0.0 及以上版本。

加入社区

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

您可以通过 GitHub Discussions 提交问题或意见。

或通过 GitHub Issues 提交 Bug 报告。

贡献代码

Umo Editor 的发展离不开社区的支持,以下是为 Umo Editor 贡献过代码的贡献者名单,向他们致谢:

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

联系我们

如果您有任何疑问或建议,请通过以下方式联系我们。在此之前,建议您详细阅读本文档,以便了解如何使用 Umo Editor。

QQ 技术交流群

支持我们

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

定制开发

如果您需要定制化开发,请联系我们,我们可以提供付费的定制化解决方案和商业支持。详细信息请访问定制开发

开源协议

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