# Doc

**Repository Path**: maxzhangchn/doc

## Basic Information

- **Project Name**: Doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-22
- **Last Updated**: 2026-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">
  <BR />
  <a target="_blank">
    Doc
  </a>
</h1>

<div align="center">
  <a href="https://www.npmjs.com/package/superdoc" target="_blank"><img src="https://img.shields.io/npm/v/superdoc.svg?color=1355ff" height="22px"></a>
  <a href="https://www.npmjs.com/package/superdoc" target="_blank"><img src="https://img.shields.io/npm/dm/superdoc.svg?color=1355ff" height="22px"></a>
  <a href="https://codecov.io/gh/superdoc-dev/superdoc" target="_blank"><img src="https://codecov.io/gh/superdoc-dev/superdoc/branch/main/graph/badge.svg" height="22px"></a>
  <a href="https://www.gnu.org/licenses/agpl-3.0" target="_blank"><img src="https://img.shields.io/badge/License-AGPL%20v3-1355ff.svg?color=1355ff" height="22px"></a>
  <a href="https://github.com/superdoc-dev/superdoc" target="_blank"><img src="https://img.shields.io/github/stars/superdoc-dev/superdoc?style=flat&color=1355ff" height="22px"></a>
  <a href="https://discord.com/invite/b9UuaZRyaB" target="_blank"><img src="https://img.shields.io/badge/discord-join-1355ff" height="22px"></a>
</div>

<p align="center">
  <strong>The document engine for DOCX files.</strong><br>
  Renders, edits, and automates .docx files in the browser, headless on the server, and within AI agent workflows.<br>
  Self-hosted. Open source. Works with React, Vue, and vanilla JS.
</p>

<div align="center">
</div>

## Quick start

```bash
npm install superdoc
```

### React

```bash
npm install @superdoc-dev/react
```

```tsx
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](packages/react/README.md) for full React documentation.

### Vanilla JavaScript

```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:

```html
<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](https://docs.superdoc.dev) or [SuperDoc.js](packages/superdoc/src/core/SuperDoc.js).

## Features

- **Real DOCX, not rich text** — Built on OOXML. Real pagination, section breaks, headers/footers. 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.
- **Headless document engine** — Server-side SDK and CLI for programmatic DOCX workflows.
- **Dual licensed** — AGPLv3 for community use. [Commercial license](https://www.superdocportal.dev/get-in-touch) for proprietary deployments.

## Examples (this workspace)

React-focused starters and demos for local engine development:

| Example | |
|---------|--|
| [React](examples/getting-started/react) | [Next.js](examples/getting-started/nextjs) |
| [Headless toolbar (MUI)](examples/advanced/headless-toolbar/react-mui) | [Headless toolbar (shadcn)](examples/advanced/headless-toolbar/react-shadcn) |
| [Custom UI demo](demos/editor/custom-ui) | |

[Browse examples](examples/) · [Browse demos](demos/)

## Documentation

[docs.superdoc.dev](https://docs.superdoc.dev) — installation, integration guides, collaboration setup, API reference, and more.

## Roadmap

See the [SuperDoc roadmap](https://github.com/superdoc-dev/superdoc/issues/1982) for what's coming next. DOCX import/export fidelity is always a top priority.

## Contributing

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.

## Community

- [Discord](https://discord.com/invite/b9UuaZRyaB) — Chat with the team and other contributors
- [Email](mailto:q@superdoc.dev) — Reach the team directly