English Documentation | [中文文档]
Introduction
Umo Viewer is a PDF document viewer built with Vue3 and PDF.js. It supports previewing PDF documents directly in the browser and also supports previewing Umo Editor document content.
Umo Viewer was created to solve the preview problem for Umo Editor documents. In most non-editing scenarios, you only need to display document content without loading the entire editor, which improves loading speed. Umo Viewer integrates seamlessly with Umo Editor documents and maintains great 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 PDF documents and Umo Editor documents, can be used solely as a PDF document viewer
- Password protection for documents
- Extensive customization options
- Multi-language support
- Custom themes
- Custom document metadata
- Print, export PDF, and share
- Automatic outline extraction and thumbnail navigation
- Zoom and responsive layout
- Display in modal dialogs or embed via iframe
- Fully compatible with Umo Editor document content
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: contact@umodoc.com
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: A PDF viewer built with Vue3 and PDF.js, enabling direct PDF preview in the browser and also supporting preview of Umo Editor documents.
- 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.