@umoteam/viewer

English Documentation | [中文文档]

中文介绍

注意：自 v1.0.0 版本起，Umo Viewer 不再支持 PDF 文档的预览。

Umo Viewer 是一款预览 Umo Editor 文档内容的文档查看器。Umo Viewer 是的诞生是为了解决Umo Editor文档的预览问题。在大部分的非编辑应用场景中，只需要显示文档内容而无需加载整个编辑器以提高加载速度，Umo Viewer 能与 Umo Editor 文档无缝集成并保持良好的兼容性。

Umo Editor 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能，支持分页模式和普通 Web 模式、Markdown 语法、富文本编辑、多种格式的节点插入、页面样式设置、文档导出与打印等功能。Umo Viewer 是 Umo Editor 的文档查看器，提供了与 Umo Editor 文档无缝集成的预览功能。

Introduction

Note: Starting from version v1.0.0, Umo Viewer no longer supports PDF document preview.

Umo Viewer is a document viewer for previewing Umo Editor documents. It was created to solve the preview problem of Umo Editor documents. In most non-editing scenarios, only the document content needs to be displayed without loading the entire editor to improve loading speed. Umo Viewer can seamlessly integrate with Umo Editor documents and maintain good compatibility.

Umo Editor is an open-source document editor based on Vue3 and Tiptap. It provides powerful document editing capabilities and AI-assisted creation features. Umo Editor supports pagination and normal web layout, Markdown syntax, rich text editing, insertion of various node types, page style settings, document export, and printing. Additionally, it supports custom extensions, multi-language settings, and a dark theme. Umo Editor also supports web layout, and you can use it as a regular rich text editor. Umo Viewer is a document viewer for Umo Editor, providing seamless integration with Umo Editor documents and preview features.

Online Experience

Visit https://www.umodoc.com/demo?target=viewer for a quick demo.

Documentation

See https://dev.umodoc.com/en/docs/viewer.

Key Features

• Support for previewing Umo Editor document content
• Password protection for documents
• Extensive customization options
• Multi-language support
• Custom themes
• Custom document metadata
• Print and share
• Automatic outline extraction
• Zoom and responsive layout
• Display in modal dialogs or embed via iframe

Browser Support

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

Environment Support

• Node.js (>=v18.0.0)
• Vue (>=v3.x)
• Vite (>=v4.x)

Join the Community

We encourage users to join the Umo Viewer open-source community and participate in the development and improvement of the product. Whether it's submitting bug reports, feature requests, or code contributions, your involvement is invaluable to our community.

Submit issues or suggestions via GitHub Discussions.

Report bugs via GitHub Issues.

Contributing

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 channels. Before doing so, we recommend reading this documentation thoroughly to understand how to use Umo Viewer.

• Feedback: GitHub Issues
• Community: GitHub Discussions
• Email: [e-mail]

Technical Exchange

• Discord：Umo Editor

Support Us

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

• ⭐ Star the Umo Viewer repository to show your support.
• 🔗 If you use Umo Viewer in your project, add a link to https://github.com/umodoc/viewer.

Products from Umo Team

• Umo Editor: A localized open-source document editor based on Vue3 and Tiptap.
• Umo Viewer: An open-source, lightweight document viewer for Umo Editor.
• Umo Editor Next: An enhanced version of Umo Editor that includes all features of the latest Umo Editor while adding or improving support for multi-user real-time collaborative editing, document annotations (comments), document version history, AI-assisted creation, document import/export, tables, and more. It also enhances customization of toolbars and sidebars.
• Umo Editor Server: A companion server-side software developed to extend Umo Editor capabilities such as multi-user collaborative editing, document annotations, and document import/export.
• Umo Office Viewer: An Office document viewer that supports previewing over 40 mainstream office document in web pages.
• Umo Office Convert: Converts over 40 office formats into web-viewable formats, ready to pair with Umo Office Viewer for seamless online document preview.

Open Source License

Umo Viewer is licensed under the MIT License. You are free to use, modify, and distribute this software, but this does not mean you are allowed to remove the copyright information at will. Please retain the Umo Viewer copyright notice and the link displayed in the interface. Removal of these will be considered an infringement. We encourage you to support open-source projects.

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