|
1 | 1 | # SuperDoc for VS Code |
2 | 2 |
|
3 | | -Open and edit `.docx` files directly in VS Code. |
| 3 | +[](https://marketplace.visualstudio.com/items?itemName=superdoc-dev.superdoc-vscode-ext) |
| 4 | +[](https://marketplace.visualstudio.com/items?itemName=superdoc-dev.superdoc-vscode-ext) |
4 | 5 |
|
5 | | -## Install |
| 6 | +Open, edit, and review Word documents directly in VS Code. |
6 | 7 |
|
7 | | -Search for **SuperDoc** in the VS Code Extensions panel, or: |
| 8 | + |
8 | 9 |
|
9 | | -```bash |
10 | | -code --install-extension superdoc-dev.superdoc-vscode-ext |
11 | | -``` |
| 10 | +## Features |
12 | 11 |
|
13 | | -Once installed, `.docx` files open with SuperDoc by default. |
| 12 | +- **Full DOCX rendering** — pagination, headings, tables, lists, signature blocks |
| 13 | +- **Edit in place** — type, format, and save without leaving VS Code |
| 14 | +- **Tracked changes** — AI agents can suggest edits as Word tracked changes |
| 15 | +- **Comments** — view and add Word comments with margin bubbles |
| 16 | +- **Live reload** — when an external process modifies the file, the document refreshes automatically |
| 17 | +- **Auto-save** — changes are saved as you type |
| 18 | +- **Context menu** — right-click any `.docx` in the Explorer and choose "Open with SuperDoc" |
14 | 19 |
|
15 | | -## Features |
| 20 | +## Install |
| 21 | + |
| 22 | +Search **"SuperDoc"** in the VS Code Extensions panel, or: |
| 23 | + |
| 24 | +``` |
| 25 | +ext install superdoc-dev.superdoc-vscode-ext |
| 26 | +``` |
16 | 27 |
|
17 | | -- **Real DOCX editing** — Formatting, tables, lists, headers — all preserved. No conversion to HTML or any intermediate format. |
18 | | -- **Pagination and rulers** — Documents render with page breaks and ruler guides, just like Word. |
19 | | -- **Auto-save** — Changes save automatically as you type. |
20 | | -- **Live reload** — When an AI agent or external process modifies your file, the document refreshes instantly. |
21 | | -- **Context menu** — Right-click any `.docx` in the Explorer and choose "Open with SuperDoc." |
| 28 | +Once installed, click any `.docx` file to open it with SuperDoc. |
22 | 29 |
|
23 | | -## How it works |
| 30 | +## AI Integration |
24 | 31 |
|
25 | | -SuperDoc renders documents directly from OOXML — the native format of `.docx` files. The extension bundles the full SuperDoc rendering and editing engine in a VS Code webview. No server calls. Your documents never leave your machine. |
| 32 | +SuperDoc provides an [MCP server](https://github.com/superdoc-dev/superdoc/tree/main/apps/mcp) that lets AI agents read, edit, and comment on Word documents programmatically. Combined with this extension, you get a live preview of AI-suggested changes — tracked changes and comments appear in real time as the agent works. |
26 | 33 |
|
27 | 34 | ## Part of SuperDoc |
28 | 35 |
|
29 | | -This extension is part of [SuperDoc](https://github.com/superdoc-dev/superdoc) — open-source DOCX editing and tooling. Renders, edits, and automates .docx in the browser and on the server. |
| 36 | +This extension is powered by [SuperDoc](https://github.com/superdoc-dev/superdoc) — open-source DOCX editing for the browser and server. No server calls — your documents never leave your machine. |
30 | 37 |
|
31 | 38 | ## License |
32 | 39 |
|
|
0 commit comments