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

MSFE 开发者文档

构建属于你的 Markdown 编辑体验。源码、交互与界面,各有清晰的职责。

MSFE 是基于 CodeMirror 的 Markdown 源码优先编辑器。你可以直接编辑文本,也可以在同一份文档上显示标题、列表、图片与自定义组件。模式切换共享内容、选区和撤销历史。

先试一试

修改正文,切换「源码」与「实时预览」,再读取 Markdown。「只读」保留阅读、选区和复制,同时关闭正文编辑。

正在准备编辑器…

从你的任务开始

你想做什么从这里开始
在应用中放入编辑器快速开始
使用 Vue、React 或原生 DOMVue 接入、React 接入、挂载与销毁
保存 Markdown、接收外部更新读取与保存
理解源码与呈现的关系源码优先
编写语法和可交互节点自定义节点
使用自己的组件库和视觉主题UI 与主题

组合你的编辑器

msfe-core 管理实例与事务,功能扩展提供语法和操作,Vue / React 适配器连接应用组件。StarterKit 组合基础 Markdown 能力;公式、图表等可选功能按需安装。

当前公共 API 处于实验阶段。接入前阅读支持范围,并将应用代码与所使用的包版本一起管理。

完成复杂开发的阅读路线

你要交付的功能从这里开始接着阅读
独立功能包与业务预设扩展模型功能与安装
可编辑业务节点自定义节点命令、异步资源
多层提示块和折叠容器与嵌套块UI 与主题
代码语言与图表渲染代码块定制图表预览、投影层
第三方 Markdown 语法Markdown 插件输入与粘贴规则
生产宿主与服务接入读取与保存选区与异步目标、图片资源
自己的交互界面工具栏搜索面板、事件与状态

示例的“接入代码”提供完整本地依赖;教程中的 TypeScript recipe 也可以直接复制。能力是否内置、是否只是示例、哪些服务由应用实现,见 支持范围。

MSFE · QuireKitMarkdown 源码始终属于你。