跳到正文
QuireKit
Core 开发文档
Alpha · API 持续演进

Core 开发文档

从 Core 的概念与 API 开始,构建自己的编辑器。

QuireKit 是基于 Tiptap Core 扩展开发的文档编辑器框架。它保留熟悉的 Editor、Extension、Node、Mark 和命令链,在 @quirekit 包族中维护统一的 ProseMirror 内核,并扩展视图、文档排版和格式转换能力。

从 Core 做到完整产品

如果目标是开发类似 Classic 的文档产品,沿构建编辑器产品逐步学习:第一个编辑器 → 文档模型 → Canvas/SVG 显示 → 命令和界面 → 内容扩展 → 产品插件 → 保存与文件。每章先解释本步要做的事,再给出局部示例和可操作的结果;需要完整实现时查阅工程参考。

Editor API、扩展合同、View API与产品 API按任务解释实际参数、返回值与副作用;原有 Core 签名作为补充查阅。

按目标阅读

我想做什么从这里开始
创建第一个编辑器快速开始
从 Tiptap 接入与 Tiptap 的关系
理解模型和数据文档与 Schema
读取服务端内容或恢复备份内容读写与校验
读取光标、选择文字或节点选区与文档位置
实现自己的能力扩展模型
编写配置、命令与运行状态行为扩展教程
响应输入或观察事务状态输入规则与 PM 插件
给节点增加交互控件NodeView 教程
在浏览器或服务端交换内容HTML 与 Markdown
查某个方法或类型Core API
查创建参数与事件回调Editor 配置与事件
试用并接入现成插件独立插件目录
接入完整分页产品,了解免费与付费使用Classic 文档

框架与产品

Core 拥有文档、事务、命令和扩展生命周期;视图负责呈现和输入;插件提供内容与行为。Classic 在这些能力之上组合分页工作区和产品界面。使用 Core 不要求安装 Classic 或 Word 包。

本页侧栏用于 Core 概念、API 和构建产品教程。顶部「插件」进入插件接入与效果目录;「Classic」进入产品文档,使用独立的入门、配置与授权目录。

当前版本

当前为 Alpha,API 仍会演进。Core 与通用扩展是 MIT,视图、产品和 Word 包各有许可与获取方式,见支持与许可。

QuireKitQuireKit · Core、插件与 Classic 文档