Skip to content

Latest commit

 

History

History
218 lines (162 loc) · 10.4 KB

File metadata and controls

218 lines (162 loc) · 10.4 KB

The document engine for AI agents and teams that need real DOCX and PDF deliverables.
Renders, edits, and automates .docx files in the browser, headless on the server, and through stateless APIs.
Tracked changes, comments, collaboration, signatures, and structured document workflows — built on real OOXML.

Why SuperDoc

Use SuperDoc when your workflow needs a real document artifact — one that humans can review, redline, comment on, approve, sign, export, and send.

Best for:

  • Legal redlines and contract review
  • Due diligence memos and reports
  • Proposal and response packs
  • Template-driven document automation
  • Human-in-the-loop agent workflows

Not for:

  • Markdown publishing or blogs
  • Note-taking apps
  • Generic text generation
  • "HTML now, export DOCX later" hacks

Start Here

I want to... Start here
Embed a DOCX editor in my app Quickstart
Let an AI agent edit documents AI agents + MCP
Run document workflows on the server Document Engine
Convert / annotate / sign / verify documents API reference
Add real-time collaboration Collaboration guides

Features

  • Real DOCX, not rich text — Built on OOXML. Real pagination, section breaks, headers/footers, comments, and tracked changes. Not a contenteditable wrapper with export bolted on.
  • Built for agents — MCP server, SDKs, CLI, and headless workflows. Agents read, edit, comment, and save real documents using structured operations.
  • Human review built in — Tracked changes, comments, approvals, and collaboration in the same workflow agents use.
  • Stateless API — Convert, annotate, sign, and verify documents without persistence. Process and return.
  • Real-time collaboration — Yjs-based CRDT for multiplayer editing with shared state.
  • Self-hosted — Runs entirely in the browser. Your documents never leave your servers.
  • Any framework — React, Vue, Angular, Svelte, vanilla JS. One component, zero lock-in.
  • Dual licensed — AGPLv3 for community use. Commercial license for proprietary deployments.

Quick Start

npm install superdoc

React

npm install @superdoc-dev/react
import { SuperDocEditor } from '@superdoc-dev/react';
import '@superdoc-dev/react/style.css';

function App() {
  return (
    <SuperDocEditor
      document={file}
      documentMode="editing"
      onReady={() => console.log('Ready!')}
    />
  );
}

See the @superdoc-dev/react README for full React documentation.

Vanilla JavaScript

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

const superdoc = new SuperDoc({
  selector: '#superdoc',
  toolbar: '#superdoc-toolbar',
  document: '/sample.docx',
  documentMode: 'editing',
});

Or use the 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>

For all available options and events, see the documentation or SuperDoc.js.

For AI Agents

If your agent needs to produce a real Word or PDF artifact, start here.

MCP server

npx @superdoc-dev/create              # generates AGENTS.md for your framework
claude mcp add superdoc -- npx @superdoc-dev/mcp   # connect agent to DOCX files

Why agents use SuperDoc

  • Structured document operations — not brittle file mutation or string replacement
  • Same document model across editor, SDK, and automation
  • Tracked changes and comments as first-class outputs
  • Reviewable artifacts humans already understand and trust

Agent entry points

Use Cases

  • AI redlining — Turn instructions into tracked changes and comments on real DOCX files
  • Diligence memos — Gather facts, draft a memo, and deliver a review-ready Word document
  • Proposal automation — Assemble response packs, compliance tables, and export-ready PDFs
  • Contract workflows — Draft, review, collaborate, sign, and verify end to end

Examples

Starter projects and workflows:

Example
React Vue
Angular Next.js
Vanilla JS CDN
Comments Track changes
Custom toolbar AI redlining
Headless AI redlining

Browse all examples

Documentation

docs.superdoc.dev — installation, framework guides, collaboration, AI workflows, document engine, API reference, and more.

Roadmap

See the SuperDoc roadmap for what's coming next. DOCX fidelity and production-grade document workflows remain top priorities.

Contributing

Check the issue tracker for open issues, or read the Contributing Guide to get started. Bug reports with reproduction .docx files are especially valuable.

Community

  • Discord — Chat with the team and other contributors
  • Email — Reach the team directly

License

Acknowledgments

Built on ProseMirror, Yjs, JSZip, and Vite.

Community Contributors

Special thanks to these community members who have contributed code to SuperDoc:

financialvice luciorubeens Dannyhvv henriquedevelops ybrodsky icaroharry asumaran J-Michalek gm1357 roncallyt gpardhivvarma lucbic claudiu-ior Branc0

Want to see your avatar here? Check the Contributing Guide to get started.


Created and maintained by Harbour and the SuperDoc community