Summary

SuperDoc is a JavaScript library for rendering and editing DOCX files in browsers and headless on servers. It targets developers building document-centric applications, offering real-time collaboration, tracked changes, and agentic workflows. The key benefit is a self-hosted, framework-agnostic solution that keeps documents private and enables powerful automation.

How It Works

Built on OOXML for true DOCX fidelity, SuperDoc uses ProseMirror for editing and Yjs (CRDT) for real-time collaboration. This approach ensures accurate rendering of complex layouts (pagination, headers/footers) and efficient, conflict-free multiplayer editing.

Quick Start & Requirements

Install via npm install superdoc or @superdoc-dev/react. It supports React, Vue, Angular, Svelte, and vanilla JS. Full documentation and starter projects are available at docs.superdoc.dev. No specific hardware/OS prerequisites beyond standard browser/Node.js environments are mentioned.

Highlighted Details

• True DOCX Support: Renders/edits DOCX using OOXML, preserving complex elements like pagination, headers, footers.
• Self-Hosted: Operates entirely client-side or server-side for data privacy.
• Framework Agnostic: Integrates with React, Vue, Angular, Svelte, vanilla JS.
• Real-time Collaboration: Yjs-based CRDT for multiplayer editing, comments, tracked changes.
• Agentic Workflows: Headless Node.js support for document automation with LLMs.
• Extensible: 60+ extensions and ProseMirror API access for custom plugins.

Maintenance & Community

Maintained by Harbour and the SuperDoc community. Community channels include Discord and email. The roadmap prioritizes DOCX import/export fidelity. Contributions are welcomed via the issue tracker.

Licensing & Compatibility

Dual-licensed: AGPLv3 for community use (copyleft) and a Commercial/Enterprise License for proprietary deployments. AGPLv3 requires derivative works to be open-sourced.

Limitations & Caveats

DOCX import/export fidelity is noted as a top priority on the roadmap, suggesting potential areas for improvement or incomplete support for all DOCX features.