Documentation

Get up and running with docx-editor — install the package, render your first editor, and explore key features.

Framework-specific installation guides for Next.js, Vite, Remix, Astro, and Vue.

Complete reference for DocxEditor props and imperative ref methods — extracted from source code.

Customize the two-level composable toolbar with render props or compound components.

Understanding the four editor modes: editing, suggesting, viewing, and readOnly.

Localize the docx-editor UI into any language. i18n support with community-contributed locales and CLI tools to add your own. Contribute new translations.

Sync DocxEditor across users with Yjs — live cursors, presence, comment sync, and tracked changes attribution.

Word-like API for AI document review — add comments, suggest replacements, accept/reject changes. Auto-generated from source.

Live demos showcasing DocxEditor props — toggle options in real time to see how each feature works.

Overview of the two plugin systems: EditorPlugin (browser) and CorePlugin (headless).

Introduction to plugins — comparison table, registration patterns, and hello world walkthrough.

Full reference for browser-side EditorPlugins — panels, overlays, ProseMirror plugins, CSS injection.

Server-side document manipulation with DocumentAgent, template processing, and CorePlugins.

Advanced plugin patterns — keyboard shortcuts, decorations, overlays, and API recipes.