How superdoc/docx-editor works
SuperDoc is a DOCX-native document engine: users open or create a DOCX, edit and review its structured content, and render or automate document operations through a shared Document API. The README documents browser editing, OOXML-backed writes, pagination, and collaboration; the source index identifies the API, editor runtime, and layout engine as substantial implementation areas. Some subsystem links below reflect README-level capability descriptions rather than inspected call sites.
Main entry points: index.ts Document API · SuperDoc.ts Browser editor · execution.ts Pagination and layout · v2-integration.js OOXML document model
Components 24
Editor entry points
- Browser editor
packages/superdoc/src/core/SuperDoc.ts - VS Code editor
apps/vscode-ext/src/superdocEditorProvider.ts - React integration
packages/react/src/SuperDocEditor.tsx - Vue integration
packages/vue/src/SuperDocEditor.ts
Document operations
- Document API
packages/document-api/src/index.ts - Document model types
packages/document-api/src/types/base.ts - Operation validation
packages/document-api/src/validation-primitives.ts - Document writes
packages/document-api/src/write/write.ts - Paragraph operations
packages/document-api/src/paragraphs/paragraphs.ts - Document queries
packages/document-api/src/find/find.ts
DOCX engine
- OOXML document model
packages/superdoc/src/core/v2-integration/v2-integration.js - Pagination and layout
packages/layout-engine/layout-engine/src/execution.ts - Paragraph layout
packages/layout-engine/layout-engine/src/layout-paragraph.ts - Table layout
packages/layout-engine/layout-engine/src/layout-table.ts - Resolved layout
packages/layout-engine/layout-resolved/src/resolveLayout.ts - Document rendering
packages/layout-engine/painters/dom/src/paragraph/renderParagraphContent.ts - List numbering
packages/word-layout/src/numbering-manager.ts
Editing experience
- Editor interface
packages/superdoc/src/core/surface-manager.js - Watermark controls
packages/superdoc/src/public/ui/watermark-controller.ts
Automation and collaboration
- Yjs collaboration
shared/common/collaboration/awareness.ts - Automation clients
- Node and Python SDKs
- CLI and MCP
Other components
- Document user
Connections 27
- Document user → Browser editor: opens or edits
README.md - Document user → VS Code editor: edits DOCX
- Document user → React integration: edits DOCX
- Document user → Vue integration: edits DOCX
- Browser editor → Document API: uses API
README.md - React integration → Browser editor: mounts editor
- Vue integration → Browser editor: mounts editor
- VS Code editor → Browser editor: hosts editor
- Document API → Document model types: uses model
- Document API → Operation validation: validates inputs
- Document API → Document writes: executes writes
- Document API → Paragraph operations: dispatches operations
- Document API → Document queries: supports queries
- Document writes → OOXML document model: writes OOXML
README.md - Browser editor → OOXML document model: edits document model
README.md - OOXML document model → Pagination and layout: lays out pages
- Pagination and layout → Paragraph layout: lays out paragraphs
packages/layout-engine/layout-engine/src/layout-paragraph.ts - Paragraph layout → Table layout: lays out tables
packages/layout-engine/layout-engine/src/layout-paragraph.ts - Pagination and layout → Resolved layout: resolves layout
- Resolved layout → Document rendering: renders content
- Pagination and layout → List numbering: formats list markers
- Browser editor → Editor interface: presents controls
- Editor interface → Watermark controls: offers watermark editing
- Browser editor → Yjs collaboration: collaborates with Yjs
README.md - Automation clients → Document API: operates documents
README.md - Node and Python SDKs → Document API: uses shared API
README.md - CLI and MCP → Document API: uses shared API
README.md