@fiduswriter/编辑器
Fidus Writer 的 ProseMirror 编辑器组件
它会做什么
Fidus Writer的主浏览器合作编辑器. 建造在 ProseMiror,它提供实时协作,评论,跟踪变化, 脚注、引用、端到端加密(E2EE)、菜单、对话框和 剪贴板导入/导出 .
主要特点
- 实时合作 ——基于 WebSocket 的协作编辑 参与者护理、 diffs 和版本
- 音轨变化 ——接受/拒绝有完整变化历史的个别变化
- 评论 - 附有注释标记和解析度的线索评论
- 脚注 ——内置有适当布局的脚注编辑
- 引用 - 基于Citeproc-js的参考书目 生成
- 欧2EE – 有密钥管理和密码句支持的端到端加密
- 拼写/语法检查器 - 内设客户端检查(Logotweaker-wasm) 带有轴下标记和替换建议,手工或连续
- 剪贴板 – 从 Word, LibreOffice, 有格式的 Google Docs 粘贴 保全
- 表格、数字和等式 对表格、图像的全面编辑支持, 数学公式和代码块
安装
npm install @fiduswriter/editor
使用量
库可以使用两种模式: 静态 (没有后端服务器,像 独立演示)或 服务器支持 (典型的菲都斯作家强哥的设定).
在没有后端的情况下快速启动, 导入 createStaticEditor 从
@fiduswriter/editor/static_editor 子路径 :
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/ 页面存档备份,存于互联网档案馆
嵌入到另一个应用程序
编辑器可以直接被嵌入主机页面(一个CMS,一个插件,另一个) ——不需要iframe:
- 用
mount选项。 这个 编辑器将其 UI 内置div.fw-editor容器(全页模式) 替换document.body而身体却带着..fw-editor) (中文(简体) ). - 装入编辑器自己的样式表 :
(单位:千美元)
fw-- 前置类和编辑根目标.fw-editor) (中文(简体) ). - 装入 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" - 添加一个惰性重设链接( N)
<link rel="stylesheet" href=".../css/reset.css" disabled />(中文(简体) ) 因此,编辑器不注入全局(未瞄准)重置. - 如果编辑器打开应留在容器内的对话框,则
主机可以添加带有裸元素选择器的视野样式表
(单位:千美元)
document.css)通过scopeCss(css, {prefix, elements: true})(由fwtoolkit) (中文(简体) ).
工作参考执行是: 嵌入式演示数字 :
demo/embedded/ 显示编辑器运行在自己的页面中
标题和内容——WordPress/Drupal/Joomla插件或任何插件的模式
其他主机会使用.
演示
在Forgejo Pages上发布独立的浏览器演示:
https://fiduswriter.pages.fiduswriter.org/fiduswriter-editor-ts/editor/ (中文(简体) )
演示器加载编辑器时没有Django后端. 启动时它会让你
选择语言,导入已有文档,或从默认开始
模板。 更改在本地保存, 可下载为 .fidus 文档.
发展
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 — 见 自由主义 详细情况.