README.md · 有墨文档/editor

# 中文介绍

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

详细介绍见： [README.zh-CN.md](https://github.com/umodoc/editor/blob/main/README.zh-CN.md)

# Introduction

Umo Editor is open-source document editor based on Vue3 and Tiptap. Umo Editor provides comprehensive document editing capabilities and AI creation features, supports pagination, supports Markdown syntax, offers basic rich text editing functions, allows for the insertion of various node types in multiple formats, provides a variety of practical tools, and supports setting page styles. It also supports exporting in various formats, printing and print preview, block-level document editing, adding custom extensions, multi-language settings, and a dark theme.

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](https://editor.umodoc.com/en/docs) | [中文文档](https://editor.umodoc.com/cn/docs) | [Live Demo](https://demo.umodoc.com/editor?lang=en-US) | [GitHub](https://github.com/umodoc/editor) | [NPM](https://www.npmjs.com/package/@umoteam/editor)

## Online Experience

Visit [Playground](https://demo.umodoc.com/editor?pane=hide&lang=en-US) for a fast experience.

## Documentation

Please visit [Documentation](https://editor.umodoc.com/en/docs).

## Design Philosophy

The birth of Umo Editor aims to address the complexity of document editing in web applications, providing open-source and free powerful editing capabilities and pagination modes similar to Microsoft Word for web projects, 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 your capable assistant.

## Open Source Advantages

- **Free to Use**: As an open-source project, Umo Editor is freely available to all developers under the [MIT License](https://github.com/umo-editor/umo-editor/blob/main/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
- Pagination mode similar to that in Microsoft Word
- 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
- AI assistant
- 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](./docs/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.

## Contributing Code

The development of Umo Editor could not have been possible without the support of the community. Below is the list of contributors who have contributed code to Umo Editor. We extend our thanks to them:

- [Umo Team](https://github.com/umodoc): 👨‍💻 Core developers
- [Cassielxd](https://github.com/Cassielxd): 💪🏻 Implemented pagination and many important features for Umo Editor
- [Na'aman Hirschfeld](https://github.com/Goldziher): 💪🏻 Enhanced TypeScript support, added tests, and provided a stronger foundation for Umo Editor's development
- [SerRashin](https://github.com/SerRashin): 🛠️ Added Russian language support for Umo Editor
- [ChenErik](https://github.com/ChenErik): 🛠️ Contributed code to Umo Editor
- [china-wangxu](https://github.com/china-wangxu): 🛠️ Contributed code to Umo Editor
- [Sherman Xu](https://github.com/xuzhenjun130): 🛠️ Contributed code to Umo Editor

We welcome all forms of contributions, 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: [contact@umodoc.com](mailto:contact@umodoc.com)

## Support Us

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

- ⭐ Star the [Umo Editor Repository](https://github.com/umodoc/editor) 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.

## License

Umo Editor is licensed under the [MIT License](https://github.com/umodoc/editor/blob/main/LICENSE), allowing you to use, modify, and distribute the software freely.

GVP 有墨文档/editor

简介

发行版

贡献者

近期动态

GVP有墨文档/editor

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

GVP 有墨文档/editor