# @fiduswriter/editor 中文文档

规范地址：https://npmcn.com/package/%40fiduswriter/editor/

版本：0\.2\.48
npm 元数据更新时间：2026-11-12T10:05:35.723Z
中文译文更新时间：2026-11-14T18:09:07.184Z
软件包许可：AGPL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40fiduswriter/editor
原文对照：https://npmcn.com/package/%40fiduswriter/editor/?lang=original
项目主页：https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/
源码仓库：https://git.fiduswriter.org/fiduswriter/fiduswriter-editor-ts

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

- 包体积（解压后）：6.8 MB，1018 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：38 个
- 首次发布：2026-07-13T20:52:18.367Z
- 最新版本发布：2026-11-12T10:05:35.539Z
- 近 30 天下载量：2336（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：116（近 12 个月 116 个）

## 中文简介

Fidus Writer 浏览器编辑器

## 安装

```sh
npm install @fiduswriter/editor
```

也可以使用：`pnpm add @fiduswriter/editor`、`yarn add @fiduswriter/editor`、`bun add @fiduswriter/editor`

## README

![@fiduswriter/editor](https://git.fiduswriter.org/fiduswriter/fiduswriter-editor-ts/raw/branch/main/logo.svg)

# @fiduswriter/编辑器

Fidus Writer 的 ProseMirror 编辑器组件

* * *

## 它会做什么

Fidus Writer的主浏览器合作编辑器. 建造在 ProseMiror,它提供实时协作,评论,跟踪变化, 脚注、引用、端到端加密(E2EE)、菜单、对话框和 剪贴板导入/导出 .

### 主要特点

-   **实时合作** ——基于 WebSocket 的协作编辑 参与者护理、 diffs 和版本
-   **音轨变化** ——接受/拒绝有完整变化历史的个别变化
-   **评论** - 附有注释标记和解析度的线索评论
-   **脚注** ——内置有适当布局的脚注编辑
-   **引用** - 基于Citeproc-js的参考书目 生成
-   **欧2EE** – 有密钥管理和密码句支持的端到端加密
-   **拼写/语法检查器** - 内设客户端检查(Logotweaker-wasm) 带有轴下标记和替换建议,手工或连续
-   **剪贴板** – 从 Word, LibreOffice, 有格式的 Google Docs 粘贴 保全
-   **表格、数字和等式** 对表格、图像的全面编辑支持, 数学公式和代码块

## 安装

```bash
npm install @fiduswriter/editor
```

## 使用量

库可以使用两种模式: **静态** (没有后端服务器,像 独立演示)或 **服务器支持** (典型的菲都斯作家强哥的设定).

在没有后端的情况下快速启动, 导入 `createStaticEditor` 从 `@fiduswriter/editor/static_editor` 子路径 :

```ts
import {createStaticEditor} from "@fiduswriter/editor/static_editor"

const editor = await createStaticEditor({
    locale: "en",
    username: "Demo User",
    documentData: async () => ({doc, doc_info, time: Date.now()}),
    documentStyles: [/* style fixtures */],
    exportTemplates: [/* export template fixtures */],
    documentTemplates: {/* document template fixtures */}
})
```

完整的 API 文档、配置选项和完整的服务器支持 项目现场有使用实例:

**[https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/ 页面存档备份,存于互联网档案馆](https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/)**

## 嵌入到另一个应用程序

编辑器可以直接被嵌入主机页面(一个CMS,一个插件,另一个) ——不需要iframe:

1.  用 `mount` 选项。 这个 编辑器将其 UI 内置 `div.fw-editor` 容器(全页模式) 替换 `document.body` 而身体却带着.. `fw-editor` ) (中文(简体) ).
2.  装入编辑器自己的样式表 : (单位:千美元)`fw-`\- 前置类和编辑根目标 `.fw-editor`) (中文(简体) ).
3.  装入 fwtoolkit 的 **范围** 主机页面的样式表。 fwtoolkit轮船 `scripts/build-scoped-css.js` 写 `css-scoped/` - 其复制件 带有页面文本的工作表 `body`编号 :`html` 适用于集装箱的规则 选择器 : `node node_modules/fwtoolkit/scripts/build-scoped-css.js --prefix "#my-app .fw-editor"`
4.  添加一个惰性重设链接( N)`<link rel="stylesheet" href=".../css/reset.css" disabled />`(中文(简体) ) 因此,编辑器不注入全局(未瞄准)重置.
5.  如果编辑器打开应留在容器内的对话框,则 主机可以添加带有裸元素选择器的视野样式表 (单位:千美元)`document.css`)通过 `scopeCss(css, {prefix, elements: true})` (由 `fwtoolkit`) (中文(简体) ).

工作参考执行是: **嵌入式演示**数字 :

**[页:1](https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/embedded/)**

`demo/embedded/` 显示编辑器运行在自己的页面中 标题和内容——WordPress/Drupal/Joomla插件或任何插件的模式 其他主机会使用.

## 演示

在Forgejo Pages上发布独立的浏览器演示:

**[https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/editor/ (中文(简体) )](https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/editor/)**

演示器加载编辑器时没有Django后端. 启动时它会让你 选择语言,导入已有文档,或从默认开始 模板。 更改在本地保存, 可下载为 `.fidus` 文档.

## 发展

```bash
npm install          # Install dependencies
npm run build        # Compile TypeScript to dist/
npm run typecheck    # Check types without emitting
npm run lint         # Lint with ESLint
npm run format:check # Check formatting with Prettier
npm test             # Run the test suite
```

## 许可证

AGPL-3.0 — 见 [自由主义](https://npmcn.com/package/%40fiduswriter/editor/LICENSE) 详细情况.

## 常见问题

### @fiduswriter/editor 是什么？

Fidus Writer 浏览器编辑器

### 如何安装 @fiduswriter/editor？

在项目目录运行 npm install @fiduswriter/editor，或使用 pnpm add / yarn add / bun add。

### @fiduswriter/editor 支持 TypeScript 吗？

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

### @fiduswriter/editor 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fiduswriter/editor 可以商用吗？

@fiduswriter/editor 使用 AGPL-3\.0 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @fiduswriter/editor 的下载量有多少？

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

### @fiduswriter/editor 还在维护吗？

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