# MSFE 开发者文档

Markdown 源码优先的编辑器。公共 API 当前为实验版本。

[English](/en/llms.txt)

- [MSFE 开发者文档](/raw/index.md): 构建属于你的 Markdown 编辑体验。源码、交互与界面，各有清晰的职责。
- [快速开始](/raw/guide/quick-start.md): 用公开包入口创建第一个编辑器，完成编辑、读取与清理。
- [功能与安装](/raw/features/catalog.md): 按需求选择内置包、可选语法、编辑命令与应用负责的能力。
- [Vue 接入](/raw/guide/vue.md): 在现有组件树内挂载编辑器，保留主题、依赖注入和视图生命周期。
- [React 接入](/raw/guide/react.md): 使用 React 适配器挂载编辑器与 Portal，保持同一应用的 Context。
- [挂载与销毁](/raw/guide/lifecycle.md): 让应用拥有容器和存储，让编辑器拥有输入、选区与运行时资源。
- [模式与只读](/raw/guide/modes.md): 在同一编辑器实例中切换源码与阅读呈现，保持内容和历史连续。
- [读取与保存](/raw/guide/saving.md): 按需读取 Markdown，通过增量事件连接存储与外部更新。
- [命令与原子事务](/raw/guide/commands.md): 调用、组合、查询和编写命令，正确处理失败、只读与撤销。
- [MD Editor 产品组件](/raw/guide/md-editor.md): 直接接入使用 QuireKit Prose 样式的 Markdown 文档编辑器。
- [Incremark 流式 Markdown](/raw/guide/incremark.md): 用优化后的 Lezer 解析流式文本，替换组件、扩展语法与节点，并显式开启安全 HTML。
- [事件与事务状态](/raw/guide/state.md): 在正确的生命周期订阅变化，区分源码、状态槽和临时存储。
- [选区与异步目标](/raw/guide/selection.md): 使用逻辑源码坐标，防止弹窗、上传和异步操作写到过期位置。
- [诊断与验证](/raw/guide/debugging.md): 定位未渲染、命令失败、资源泄漏和复杂扩展的交互问题。
- [可选源码协同](/raw/guide/collaboration.md): 按需加入多人编辑、远端光标和协作者列表。
- [自定义节点导出为 Word、PDF 与 OFD](/raw/guide/export-nodes.md): 共用原生内容转换和图片渲染，处理模板、资源失败、取消与 Word 元数据恢复。
- [源码优先](/raw/concepts/source-first.md): 理解 Markdown、派生字段、组件视图和事务之间的关系。
- [扩展模型与组合](/raw/concepts/extensions.md): 理解 create、configure、extend、安装顺序和完整生命周期。
- [自定义节点](/raw/extensions/custom-node.md): 从一个可点击的状态标记，理解语法、字段、命令和组件的完整接入。
- [容器与嵌套块](/raw/extensions/containers.md): 注册业务容器、定义样式、嵌套正文并接入自己的折叠控件。
- [代码块定制](/raw/extensions/code-blocks.md): 定制工具栏、语言高亮和样式，理解与整块预览的边界。
- [图表与代码块预览](/raw/extensions/diagrams.md): 从 Mermaid 流程图到 ECharts，构建具有加载、失败回退和清理的源码预览。
- [Markdown 插件](/raw/extensions/markdown-plugins.md): 把新的语法接入增量解析、语义查询和源码呈现，而不引入 HTML 往返。
- [输入与粘贴规则](/raw/extensions/input-rules.md): 显式转换新输入，保持组合输入、范围边界和撤销的一致性。
- [投影层与组件生命周期](/raw/extensions/projections.md): 正确实现内联装饰、跨行预览、状态依赖和测量。
- [异步资源与清理](/raw/extensions/resources.md): 组织加载、取消、重试、锚点和释放，避免旧结果写入新文档。
- [UI 与主题](/raw/customization/theme.md): 接入自己的设计体系，同时保持源码、命令和组件的边界。
- [工具栏与弹窗](/raw/customization/toolbars.md): 用组件库构建命令入口，正确同步适用性、选区和异步表单。
- [自定义搜索面板](/raw/customization/search.md): 替换搜索 UI，保留统一的查询、选中和替换事务。
- [图片与外部资源](/raw/customization/images.md): 为私有资源配置解析、释放和插入流程，避免把临时 URL 当持久数据。
- [编辑器 API](/raw/api/editor.md): 查询当前公开的创建选项、实例方法与增量事件。
- [源码与组件 API](/raw/api/source.md): 查询扩展如何读取语法、修改字段，以及组件可使用的动作。
- [扩展 API](/raw/api/extensions.md): 扩展钩子、预设、输入规则、容器及其控制协议。
- [命令与目标 API](/raw/api/commands.md): 命令草稿、失败结果、外部修改与异步范围协议。
- [状态与资源 API](/raw/api/state.md): 状态定义、效果、订阅和异步资源的类型化协议。
- [渲染与宿主 API](/raw/api/rendering.md): 投影层、组件挂载、语言、搜索以及图表操作协议。
- [支持范围](/raw/support.md): 在选择语法、框架和交互方案之前，了解当前能力与限制。