跳到正文
QuireKit MSFE
开发者文档
v0.0.0 · 实验版本

支持范围

在选择语法、框架和交互方案之前,了解当前能力与限制。

基础能力

能力当前支持
编辑模式源码、实时预览、只读,独立只读配置与共享历史
框架原生 DOM、Vue、React;Vue / React 宿主保留应用上下文
基础语法标题、强调、粗体、链接、图片、代码、引用、列表、任务、表格和正文转义等
扩展开发字段 codec、命令、规则、组件视图、投影层和生命周期
持久化Markdown 读取、增量事件、版本化外部修改与显式换文档

可选语法

msfe-markdown-extras 提供 Frontmatter、脚注、公式、Mermaid、Callout、自定义容器、上下标、高亮、插入线、Emoji、缩写、定义列表与排版替换。它们需要显式安装和配置。

msfe-html 提供受限的静态 HTML 呈现,默认不会执行文档脚本。代码语言高亮通过宿主提供的语言目录按需加载。

需要知道的边界

  • 语法支持不等于全部 CommonMark / GFM 渲染一致性已完成认证。
  • 未知、未闭合或不支持的结构保留源码;公式、图表、图片资源失败时按功能约定回退。
  • Node / Mark 是源码扩展声明,不能直接安装 ProseMirror 插件或任意 Tiptap 扩展。
  • 任意可编辑组件正文、完整复杂表格交互和全浏览器辅助技术验证仍有开放范围。
  • 当前未提供 Yjs 协同集成;版本化修改接口不能代替协同协议。

文档与版本

当前 API 为实验版本。使用与应用包版本对应的文档,保存公共入口和完整示例的依赖配置。本站的 API 签名、可复制示例和 AI 文本从同一份来源生成。

内置、示例与宿主实现

分类当前文档中的内容
内置功能StarterKit、可选 Markdown extras、受限 HTML、框架 Host
完整可运行扩展示例状态节点、嵌套容器、代码语言工具栏、徽标语法、Mermaid + ECharts
可复制宿主模块顺序自动保存、状态槽、输入规则、私有图片解析、异步范围意图
需要额外适配flowchart.js 等新引擎、自定义嵌套图表、服务器持久化、上传和多人协同

ECharts 示例只支持本文定义的数据协议及顶层围栏,不等于内核支持全部 EChartsOption。React 公共接入有代码说明,本站交互 demo 运行 Vue。需要移植第三方语法时遵循 插件教程 的解析、语义、呈现、写回四个环节。

升级回归

固定一组包版本,保留你自己的源码 fixtures 和主题截图。升级后回归字段写回、撤销、IME、拖选、只读、异步取消与导出;不能只看 TypeScript 编译通过。完整矩阵见 诊断与验证。

MSFE · QuireKitMarkdown 源码始终属于你。