diff --git a/README.md b/README.md index 8d9414e410..55e4fb5834 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@

- A JavaScript library that renders and edits DOCX files in the browser, headless on the server, and within agentic workflows.
- Tracked changes, complex tables, headers/footers, real-time collaboration — the features your users actually need.
+ The document engine for DOCX files.
+ Renders, edits, and automates .docx files in the browser, headless on the server, and within AI agent workflows.
Self-hosted. Open source. Works with React, Vue, and vanilla JS.

@@ -87,7 +87,6 @@ For all available options and events, see the [documentation](https://docs.super - **Any framework** — React, Vue, Angular, Svelte, vanilla JS. One component, zero lock-in. - **Real-time collaboration** — Yjs-based CRDT. Multiplayer editing with comments, tracked changes, and automatic conflict resolution. - **Agentic tooling** — Runs headless in Node.js. Bring your own LLM for document automation, redlining, and template workflows. -- **Extensible** — 60+ built-in extensions. Write custom plugins with full ProseMirror access. - **Dual licensed** — AGPLv3 for community use. [Commercial license](https://www.superdocportal.dev/get-in-touch) for proprietary deployments. ## Examples diff --git a/apps/cli/README.md b/apps/cli/README.md index 5545a8156f..d2584845ae 100644 --- a/apps/cli/README.md +++ b/apps/cli/README.md @@ -368,7 +368,7 @@ Error: ## Part of SuperDoc -This CLI is part of the [SuperDoc](https://github.com/superdoc-dev/superdoc) project — an open source document editor bringing Microsoft Word to the web. Use it alongside the editor, or standalone for document automation. +This CLI is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — the open-source document engine for DOCX files. Renders, edits, and automates .docx in the browser and on the server. ## License diff --git a/apps/docs/getting-started/introduction.mdx b/apps/docs/getting-started/introduction.mdx index 1517f9fdaa..a7bd32e415 100644 --- a/apps/docs/getting-started/introduction.mdx +++ b/apps/docs/getting-started/introduction.mdx @@ -4,19 +4,21 @@ sidebarTitle: Introduction keywords: "docx editor, microsoft word web, word compatibility, document editing api, contract management software, word documents online" --- -Your users need real Word documents. Not "Word-like." Not "compatible." Actual `.docx` files with tracked changes, complex tables, and section breaks that open perfectly in Microsoft Word. +The document engine for DOCX files. Renders, edits, and automates .docx documents in the browser, headless on the server, and within AI agent workflows. ## What SuperDoc does -A JavaScript library that renders and edits Word documents in the browser. Comments, tracked changes, complex tables, headers/footers, real-time collaboration — every feature users actually rely on. Built for advanced documents like legal contracts and enterprise workflows. +Your users need real Word documents. Not "Word-like." Not "compatible." Actual `.docx` files with tracked changes, complex tables, and section breaks that open perfectly in Microsoft Word. + +SuperDoc renders and edits DOCX files directly in the browser. Built on OOXML — not bolted onto HTML. As you type, you write to the XML. Import a document, edit it, export it. Nothing lost. ## Why it works - **Real DOCX, not rich text** — This isn't another contenteditable wrapper. SuperDoc handles actual `.docx` files with their full complexity. - **Any framework** — React, Vue, Angular, Svelte, vanilla JS. One component, zero lock-in. -- **Frontend and backend** — Runs in the browser or headless in Node.js for AI agents and automation. -- **Extensible** — Custom plugins, commands, nodes, and UI. Full ProseMirror access when you need it. -- **Dual licensed** — AGPLv3 for community use, Commercial License for enterprise. +- **Self-hosted** — Runs entirely in the browser. Your documents never leave your servers. +- **Programmable** — API, SDK, CLI, MCP server. Run headless in Node.js for AI agents and automation. The same engine — visual or headless. +- **Dual licensed** — AGPLv3 for community use, Commercial License for proprietary deployments. ## Next steps diff --git a/apps/vscode-ext/README.md b/apps/vscode-ext/README.md index 4b6778e511..6f1b6101c5 100644 --- a/apps/vscode-ext/README.md +++ b/apps/vscode-ext/README.md @@ -16,7 +16,7 @@ Once installed, any `.docx` file you open will automatically use SuperDoc. Just ## **Install** -**Coming soon to the VS Code Marketplace.** Star this repository to get notified. +Not yet on the VS Code Marketplace. Install from VSIX or run from source. ### Install from VSIX @@ -41,6 +41,10 @@ npm run compile Then press `F5` in VS Code to launch a development window. +## Part of SuperDoc + +This extension is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — the open-source document engine for DOCX files. Renders, edits, and automates .docx in the browser and on the server. + ## **License** -This project is licensed under the GNU Affero General Public License version 3.0 (AGPLv3). See the full license at [gnu.org/licenses/agpl-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html). +AGPL-3.0 · [Enterprise license available](https://superdoc.dev) diff --git a/packages/sdk/langs/node/README.md b/packages/sdk/langs/node/README.md index 84b93ea9d2..7e9635a5ea 100644 --- a/packages/sdk/langs/node/README.md +++ b/packages/sdk/langs/node/README.md @@ -134,7 +134,7 @@ Multi-action tools use an `action` field to select the underlying operation. Sin ## Part of SuperDoc -This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — an open source document editor bringing Microsoft Word to the web. +This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — the open-source document engine for DOCX files. Renders, edits, and automates .docx in the browser and on the server. ## License diff --git a/packages/sdk/langs/python/README.md b/packages/sdk/langs/python/README.md index 0f224908e9..db112d7ae0 100644 --- a/packages/sdk/langs/python/README.md +++ b/packages/sdk/langs/python/README.md @@ -386,7 +386,7 @@ pip download superdoc-sdk superdoc-sdk-cli-darwin-arm64 ## Part of SuperDoc -This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — an open source document editor bringing Microsoft Word to the web. +This SDK is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — the open-source document engine for DOCX files. Renders, edits, and automates .docx in the browser and on the server. ## License diff --git a/packages/superdoc/README.md b/packages/superdoc/README.md index 2d65954979..01271add5a 100644 --- a/packages/superdoc/README.md +++ b/packages/superdoc/README.md @@ -1,34 +1,29 @@ -# 🦋️📝️ SuperDoc +# SuperDoc -> The modern collaborative document editor for the web +> The document engine for DOCX files. [![Documentation](https://img.shields.io/badge/docs-available-1355ff.svg)](https://docs.superdoc.dev/) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-1355ff.svg)](https://www.gnu.org/licenses/agpl-3.0) [![npm version](https://img.shields.io/npm/v/superdoc.svg?color=1355ff)](https://www.npmjs.com/package/superdoc) -[![Discord](https://img.shields.io/badge/discord-join-1355ff)](https://discord.gg/FBeRDqWy) +[![Discord](https://img.shields.io/badge/discord-join-1355ff)](https://discord.com/invite/b9UuaZRyaB) -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. +SuperDoc renders and edits DOCX files in the browser. Built on OOXML — not bolted onto HTML. As you type, you write directly to the XML. Import a document, edit it, export it. Nothing lost. -## ✨ Features +## 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 -- **Paginated Layout**: True WYSIWYG editing with accurate page rendering powered by the layout engine -- **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 +- **Real DOCX, not rich text** — Built on OOXML. Real pagination, section breaks, headers/footers, complex tables. Not a contenteditable wrapper with export bolted on. +- **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. +- **Real-time collaboration** — Yjs-based CRDT. Multiplayer editing with comments, tracked changes, and automatic conflict resolution. +- **Built for agents** — [SDK](https://www.npmjs.com/package/@superdoc-dev/sdk), [CLI](https://www.npmjs.com/package/@superdoc-dev/cli), and [MCP server](https://www.npmjs.com/package/@superdoc-dev/mcp) let LLMs read, edit, and save .docx files programmatically. +- **Dual licensed** — AGPLv3 for community use. [Commercial license](https://www.superdocportal.dev/get-in-touch) for proprietary deployments. -## 🚀 Quick Start - -### Installation +## Quick start ```bash npm install superdoc ``` -### Basic Usage - ```javascript import 'superdoc/style.css'; import { SuperDoc } from 'superdoc'; @@ -39,91 +34,32 @@ const superdoc = new SuperDoc({ { id: 'my-doc-id', type: 'docx', - data: fileObject, // Optional: JS File object if not using collaboration + data: fileObject, }, ], }); ``` -## 🛠️ Development Setup - -1. **Clone the Repository** - -```bash -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) - - ```bash - cd packages/superdoc - npm install && npm run dev - ``` - -- **/packages/super-editor**: Core editor component - ```bash - cd packages/super-editor - npm install && npm run dev - ``` - -## 🏗️ Architecture - -SuperDoc uses a **paginated-only** rendering approach powered by `PresentationEditor` and the layout engine: - -- **For web applications**: Use `SuperDoc` - it automatically uses `PresentationEditor` for paginated rendering -- **For Node.js/CLI/headless environments**: Use `Editor` directly from `@superdoc/super-editor` - -The layout engine provides: -- True WYSIWYG page rendering with accurate pagination -- Support for multi-column layouts, headers, footers, and section breaks -- Virtualization for optimal performance with large documents -- Zoom controls and responsive page scaling - -**Note**: If you need a flow-mode (unpaginated) editor, use the core `Editor` class directly. SuperDoc is designed for paginated document editing. - -## 📖 Documentation - -For comprehensive documentation, visit our [SuperDocumentation](https://docs.superdoc.dev) 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: +For React, Vue, and other frameworks, see the [documentation](https://docs.superdoc.dev). -1. Check our [issue tracker](https://github.com/superdoc-dev/superdoc/issues) 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 +## Documentation -See our [Contributing Guide](CONTRIBUTING.md) for more details. +[docs.superdoc.dev](https://docs.superdoc.dev) — installation, integration guides, collaboration setup, API reference, and more. -## 💬 Community +## Contributing -- [Discord Server](https://discord.gg/FBeRDqWy) - Join our community chat -- [GitHub Discussions](https://github.com/superdoc-dev/superdoc/discussions) - Ask questions and share ideas -- [Email Support](mailto:support@harbourshare.com) - Get help from our team +Check the [issue tracker](https://github.com/superdoc-dev/superdoc/issues) for open issues, or read the [Contributing Guide](../../CONTRIBUTING.md) to get started. Bug reports with reproduction .docx files are especially valuable. -## 📄 License +## Community -- Open Source: [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html) -- Commercial: [Enterprise License](https://www.harbourshare.com/request-a-demo) +- [Discord](https://discord.com/invite/b9UuaZRyaB) — Chat with the team and other contributors +- [Email](mailto:q@superdoc.dev) — Reach the team directly -## 📱 Contact +## License -- [✉️ Email](mailto:support@harbourshare.com?subject=[SuperDoc]%20Project%20inquiry) -- [🔗 LinkedIn](https://www.linkedin.com/company/harbourshare/) -- [⛵️ Website](https://superdoc.dev) +- Open source: [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html) +- Commercial: [Enterprise License](https://www.superdocportal.dev/get-in-touch) --- -Created and actively maintained by [Harbour](https://www.harbourshare.com) and the SuperDoc community. +Created and maintained by [Harbour](https://www.superdoc.dev) and the SuperDoc community.