@harbour-enterprises/superdoc

🦋️📝️ SuperDoc

The modern collaborative document editor for the web

SuperDoc is a powerful document editor that brings Microsoft Word-level capabilities to your web applications. With real-time collaboration, extensive formatting options, and seamless integration capabilities, SuperDoc makes document editing on the web better for everyone.

✨ Features

• Document Compatibility: View and edit DOCX and PDF documents directly in the browser
• Microsoft Word Integration: Full support for importing/exporting, advanced formatting, comments, and tracked changes
• Real-time Collaboration: Built-in multiplayer editing, live updates, commenting, sharing, and revision history
• Framework Agnostic: Seamlessly integrates with Vue, React, or vanilla JavaScript
• Extensible Architecture: Modular design makes it easy to extend and customize
• Dual License: Available under AGPLv3 for community use and Commercial license for enterprise deployments

🚀 Quick Start

Installation

npm install @harbour-enterprises/superdoc

Basic Usage

import '@harbour-enterprises/superdoc/style.css';
import { SuperDoc } from '@harbour-enterprises/superdoc';

const superdoc = new SuperDoc({
  selector: '#superdoc',
  documents: [{
    id: 'my-doc-id',
    type: 'docx',
    data: fileObject  // Optional: JS File object if not using collaboration
  }]
});

🛠️ Development Setup

1. Clone the Repository

git clone https://github.com/your-username/SuperDoc.git
cd SuperDoc

2. Choose Your Package

SuperDoc consists of two main packages:

• /packages/superdoc: Main package (recommended)

  cd packages/superdoc
  npm install && npm run dev

• /packages/super-editor: Core editor component

  cd packages/super-editor
  npm install && npm run dev

📖 Documentation

For comprehensive documentation, visit our SuperDocumentation site. Key topics include:

• Complete API reference
• Integration guides
• Collaboration setup
• Advanced customization
• Best practices

🤝 Contributing

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

• Discord Server - Join our community chat
• GitHub Discussions - Ask questions and share ideas
• Email Support - Get help from our team

📄 License

• Open Source: GNU Affero General Public License v3.0
• Commercial: Enterprise License

📱 Contact

• ✉️ Email
• 🔗 LinkedIn
• ⛵️ Website

---

Created and actively maintained by Harbour and the SuperDoc community.