Skip to content

README.md

Latest commit

 

History

History
134 lines (98 loc) · 5.8 KB

README.md

File metadata and controls

134 lines (98 loc) · 5.8 KB

SuperDoc logo
SuperDoc


SuperDoc (online demo) is an open source document editor bringing Microsoft Word capabilities to the web with real-time collaboration, extensive formatting options, and easy integration. Self-hostable with Vanilla JS, React, Vue, and more (code examples).

🖼️ Screenshot

✨ Features

  • 📝 Microsoft Word compatible: View and edit DOCX documents with great import/export, advanced formatting, comments, and tracked changes
  • 🛠️ Easy to integrate: Open source, can be self-hosted, seamlessly integrates with React, Vue, vanilla JavaScript, and more
  • 👥 Real-time collaboration: Features multiplayer editing, live updates, commenting, sharing, and revision history
  • 📐 Extensible architecture: Modular design makes it easy to extend, brand, and customize
  • ✅ Dual licensed: Available under AGPLv3 for community use and Commercial license for enterprise deployments

💡 Quick start

Installation

npm install superdoc

Or install with CDN

<link rel="stylesheet" href="https://unpkg.com/superdoc/dist/style.css" />
<script type="module" src="https://unpkg.com/superdoc/dist/superdoc.umd.js"></script>

Basic usage

import 'superdoc/style.css';
import { SuperDoc } from 'superdoc';

// For CDN use - `SuperDocLibrary.SuperDoc`
const superdoc = new SuperDoc({
  selector: '#superdoc',
  toolbar: '#superdoc-toolbar',
  document: '/sample.docx', // URL, File or document config
  documentMode: 'editing',
  rulers: true,
  onReady: (event) => {
    console.log('SuperDoc is ready', event);
  },
  onEditorCreate: (event) => {
    console.log('Editor is created', event);
  },
});

SuperDoc now uses the layout-engine powered PresentationEditor under the hood, so pages/zoom/error telemetry are always available—no pagination flag required.

For a list of all available properties and events, see the documentation or refer to SuperDoc.js

📖 Documentation

Visit our documentation site and code examples. Key topics include:

  • Installation
  • Integration guides
  • Collaboration setup
  • Advanced customization
  • Best practices

🎯️ Roadmap

We keep our big work-in-progress items here:

  • Check out our SuperDoc roadmap
  • We prioritize the solving of big DOCX import/export/formatting needs

🤝 Contribute

We love contributions! Here's how you can help:

  1. Check our issue tracker for open issues
  2. Fork the repository and create a feature/bugfix branch
  3. Write clear, documented code following our style guidelines
  4. Submit a PR with detailed description of your changes

See our Contributing Guide for more details.

💬 Community

📄 License

🙌 Shout-outs

📱 Contact

Created and actively maintained by Harbour and the SuperDoc community