# DOCX Editor — @eigenpal/docx-js-editor
> Open-source WYSIWYG DOCX editor for React. Edit .docx files in the browser with full fidelity — tables, images, tracked changes, threaded comments, realtime collaboration via Yjs, and i18n. MIT licensed, no server required.

Install: `npm install @eigenpal/docx-js-editor` — works with React 18+/19, Vite, Next.js, Remix, Astro.

## Links
- [npm](https://www.npmjs.com/package/@eigenpal/docx-js-editor): package, install command, version history
- [GitHub](https://github.com/eigenpal/docx-editor): source, issues, and discussions
- [llms-full.txt](https://www.docx-editor.dev/llms-full.txt): the entire docs corpus concatenated into one plain-text document

## Getting Started
- [Getting Started](https://www.docx-editor.dev/docs/getting-started): Get up and running with docx-editor — install the package, render your first editor, and explore key features.
- [Installation](https://www.docx-editor.dev/docs/installation): Framework-specific installation guides for Next.js, Vite, Remix, Astro, and Vue.

## API Reference
- [Props & Ref Methods](https://www.docx-editor.dev/docs/props): Complete reference for DocxEditor props and imperative ref methods — extracted from source code.

## Realtime Collaboration
- [Realtime Collaboration](https://www.docx-editor.dev/docs/realtime-collaboration): Sync DocxEditor across users with Yjs — live cursors, presence, comment sync, and tracked changes attribution.

## Customization
- [Toolbar Customization](https://www.docx-editor.dev/docs/toolbar): Customize the two-level composable toolbar with render props or compound components.
- [Editor Modes](https://www.docx-editor.dev/docs/modes): Understanding the four editor modes: editing, suggesting, viewing, and readOnly.

## Examples
- [Interactive Examples](https://www.docx-editor.dev/docs/examples): Live demos showcasing DocxEditor props — toggle options in real time to see how each feature works.

## Configuration
- [Translations (i18n)](https://www.docx-editor.dev/docs/translations): Localize the docx-editor UI into any language. i18n support with community-contributed locales and CLI tools to add your own. Contribute new translations.

## Plugins
- [Plugin System](https://www.docx-editor.dev/docs/plugins): Overview of the two plugin systems: EditorPlugin (browser) and CorePlugin (headless).
- [Plugin Getting Started](https://www.docx-editor.dev/docs/plugins/getting-started): Introduction to plugins — comparison table, registration patterns, and hello world walkthrough.
- [EditorPlugin API](https://www.docx-editor.dev/docs/plugins/editor-plugins): Full reference for browser-side EditorPlugins — panels, overlays, ProseMirror plugins, CSS injection.
- [CorePlugin & Headless API](https://www.docx-editor.dev/docs/plugins/core-plugins): Server-side document manipulation with DocumentAgent, template processing, and CorePlugins.
- [Plugin Examples & Cookbook](https://www.docx-editor.dev/docs/plugins/examples): Advanced plugin patterns — keyboard shortcuts, decorations, overlays, and API recipes.

## Agent Framework
- [DocxReviewer API](https://www.docx-editor.dev/docs/agent-api): Word-like API for AI document review — add comments, suggest replacements, accept/reject changes. Auto-generated from source.