# @casualoffice/docs 中文文档

规范地址：https://npmcn.com/package/%40casualoffice/docs/

版本：1\.4\.2
npm 元数据更新时间：2026-07-10T21:12:25.386Z
中文译文更新时间：2026-11-09T04:44:02.839Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40casualoffice/docs
原文对照：https://npmcn.com/package/%40casualoffice/docs/?lang=original
项目主页：https://docx-editor.dev/
源码仓库：https://github.com/CasualOffice/docs

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：11.7 MB，251 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：@hocuspocus/provider ^2\.15\.0，prosemirror-commands ^1\.5\.2，prosemirror-dropcursor ^1\.8\.2，prosemirror-history ^1\.4\.0，prosemirror-keymap ^1\.2\.2，prosemirror-model ^1\.19\.4，prosemirror-state ^1\.4\.3，prosemirror-tables ^1\.8\.5，prosemirror-transform ^1\.10\.2，prosemirror-view ^1\.41\.6，react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0，y-prosemirror ^1\.2\.0，y-websocket ^2\.0\.0，yjs ^13\.6\.0
- 首次发布：2026-07-07T22:04:02.909Z
- 最新版本发布：2026-07-10T21:12:25.259Z
- 近 30 天下载量：13858（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

基于浏览器的 DOCX 有可变插入支持的模板编辑器

## 安装

```sh
npm install @casualoffice/docs
```

也可以使用：`pnpm add @casualoffice/docs`、`yarn add @casualoffice/docs`、`bun add @casualoffice/docs`

## README

[![Casual Editor](https://npmcn.com/package/%40casualoffice/docs/.https://raw.githubusercontent.com/eigenpal/docx-editor/main/assets/logo.svg)](https://docs.casualoffice.org/)

## 临时编辑器-编辑包

建造在 [eigenpal/docx编辑器](https://github.com/eigenpal/docx-editor) (麻省理工学院).

此目录持有 Casual 编辑器的浏览器编辑器代码库. 所有项目(建筑、部署、后端计划)的生活 输入 **[外读](https://npmcn.com/package/%40casualoffice/README.md)** - 从那里开始.

这个读取器只是里面的地图 `docx-editor/` 这样 人们浏览包本身 不必在周围粘贴.

## 软件包

| 路径 | 这是什么 |
| --- | --- |
| `packages/core/` | DOCX 解析器 + 序列器, 排版引擎, ProseMiror schema |
| `packages/react/` | 这个 `<DocxEditor>` 反应组件(被演示使用) |
| `packages/vue/` | Vue 包装器(私营、社区维护、未出版) |

## 有用命令

从里面跑 `docx-editor/`1.3.14号机舱需要.

```bash
bun install
bun run dev           # vite demo at http://localhost:5173
bun run typecheck     # type-check every package
bun test              # unit tests
bun run test:e2e      # Playwright e2e (chromium)
bun run build         # build core + react packages
bun run build:demo    # build the Vite demo bundle
```

往返审计( 列出我们默默地跳到保存上的每个 OOXML 标签) :

```bash
bun run scripts/roundtrip-audit.mjs
# writes roundtrip-audit-report.md
```

## 建筑作弊表

编辑有 **2个导管** 必须保持同步 :

```
┌──────────────────────────────────────────────────────────────┐
│ HIDDEN ProseMirror (off-screen)                              │
│   real editing state, selection, undo/redo, commands         │
│   src/paged-editor/HiddenProseMirror.tsx                     │
└──────────────────────────────────────────────────────────────┘
                state changes ↓ trigger re-render
┌──────────────────────────────────────────────────────────────┐
│ VISIBLE pages (layout-painter)                               │
│   what the user actually sees, has its own render logic      │
│   src/layout-painter/renderPage.ts                           │
└──────────────────────────────────────────────────────────────┘
```

修复视觉错误时,请编辑 `layout-painter/`时 编辑行为错误,编辑 `prosemirror/extensions/`对于两者,你 通常需要触摸两条管道.

见 `CLAUDE.md` 用于完整“ 关键文件地图” 的目录 日常活计.

## 许可证

麻省理工学院`docx-editor/LICENSE`) (中文(简体) ). 衍生自 [`eigenpal/docx-editor`](https://github.com/eigenpal/docx-editor) 下级 同样的麻省理工学院许可;其版权通知保留.

## 常见问题

### @casualoffice/docs 是什么？

基于浏览器的 DOCX 有可变插入支持的模板编辑器

### 如何安装 @casualoffice/docs？

在项目目录运行 npm install @casualoffice/docs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prosemirror-commands（^1\.5\.2）、prosemirror-dropcursor（^1\.8\.2）、prosemirror-history（^1\.4\.0）、prosemirror-keymap（^1\.2\.2）、prosemirror-model（^1\.19\.4）、prosemirror-state（^1\.4\.3）、prosemirror-tables（^1\.8\.5）、prosemirror-transform（^1\.10\.2）、prosemirror-view（^1\.41\.6）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @casualoffice/docs 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @casualoffice/docs 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @casualoffice/docs 可以商用吗？

@casualoffice/docs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @casualoffice/docs 的下载量有多少？

根据 npm 官方下载统计，@casualoffice/docs 在 2026/10/09 – 2026/11/07 这 30 天内被下载 13,858 次，日均约 462 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @casualoffice/docs 还在维护吗？

最新版本 1\.4\.2 发布于 2026/07/11（3 个月前）；至今共发布 4 个版本，其中过去 12 个月发布了 4 个；首次发布于 2026/07/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。