Examples
Runnable DOCX editor starters for React, Vue, server-rendered frameworks, collaboration, agents, and export.
Choose an example
Each starter lives in the repository's examples/ directory.
| Task | Example |
|---|---|
| Mount the packaged editor | Happy path |
| Start from a framework | Vite, Next.js, Remix, Astro, Vue, Nuxt |
| Build custom chrome | Igloo Editor |
| Embed custom nodes in content controls | Custom nodes |
| Replace a document at runtime | Document refresh |
| Scroll to and highlight paragraph references | Anchor navigation |
| Move the editor into another window | Pop-out window |
| Automate a document | Document automation |
| Connect an agent | Roast My Doc, Writer agent, Server agent review |
| Collaborate in real time | Peer-to-peer, Server-backed |
| Export a document | DOCX to Markdown, DOCX to PDF |
Run a repository starter
Clone the repository, then install dependencies and build the packages from the root:
git clone https://github.com/eigenpal/docx-editor.git
cd docx-editor
bun install
bun run build:packagesRun the bun run dev:* command from the starter README. The Vite with React and Vite with Vue starters alias package source and do not need build:packages.
Use published packages
- Web starters use
workspace:*dependencies for@docx-editor.dev/*packages, not published npm versions. - To use published packages, replace the
workspace:*versions in the starter'spackage.json. - The Vue adapter is published to npm. The Nuxt module is a private workspace package.
Try the live demo
This demo runs <DocxEditor> on this page. Open one of your .docx files in it.
Next steps
- Quickstart: Build a load, edit, and save flow.
- Installation: Set up your framework.
- Build a DOCX agent: Apply and show agent updates.