游乐游手机版
首页/前端开发/文章详情

MarkView纯前端Markdown实时预览工具架构设计

时间:2026-07-19 18:43
MarkView是一款纯前端Markdown实时预览工具,数据存于IndexedDB,零后端。采用CodeMirror6编辑并分层架构:core层纯逻辑可测试,controllers封装命令式操作,workspace组织响应式状态,组件仅渲染。渲染在WebWorker执行,滚动同步基于锚点表插值,分享通过压缩文档至URLhash,PWA可注册为 md文件处理

MarkView 是一款纯前端的本地 Markdown 实时预览工具(官网:markview.art)。它左侧采用 CodeMirror 6 编辑器,右侧实时渲染,所有数据均存储于浏览器的 IndexedDB 中,完全无需后端服务。支持暗色/浅色主题、命令面板、URL 分享,并可作为 PWA 离线安装,甚至能注册为系统 .md 文件处理器——双击本地文件即可直接打开。

本文不逐一罗列功能,而是深入探讨其架构取舍:如何在一个没有后端、没有状态管理库的 Vue 3 项目中,将编辑器、渲染、持久化、搜索、同步等子系统组织得清晰可测,为开发者提供参考。

一、为什么是「纯前端」

首先聊聊定位。市面上 Markdown 编辑器众多,MarkView 选择了约束最强的路线:零后端、零上传、离线可用。文档全部存储在浏览器 IndexedDB 中,分享通过将文档压缩进 URL hash 实现,链接自包含。PWA 预缓存构建产物,即使断网也能正常编辑和预览。

这一约束反过来塑造了诸多技术决策,带来了一系列精巧的设计。例如图片处理:没有后端就没有图床,因此粘贴或拖拽的图片会被压缩(缩放+WebP编码)为 base64 直接内联进文档——图片随文档一起存储本地,分享和导出天然自包含。再如 PDF 导出:不引入 html2pdf 等庞大依赖,直接调用浏览器原生打印,得到文字可选、体积小的矢量输出,版式交给一份 @media print 样式表。

二、CodeMirror-First 分层架构

整个项目的核心设计是一套严格单向依赖的分层架构,从下到上依次为:

 复制代码components(哑组件,inject 工作区直接消费)
    ↓
workspace(响应式状态 + 横切编排)
    ↓
controllers(EditorController / PreviewController,命令式门面)
    ↓
core(纯逻辑领域层:零 Vue、零 DOM,Vitest 直测)

core:零 Vue、零 DOM 的纯领域层

最底层的 core/ 是一个纯函数世界:文档模型、IndexedDB 存储、保存状态机、Markdown 渲染与源行标注、跨文档搜索、滚动锚点表、分享链接编解码……全部不依赖 Vue 和 DOM。其优势显而易见:这一层可直接被 Vitest 测试,无需挂载组件、无需模拟浏览器环境。测试文件与被测模块同目录放置,例如保存状态机的防抖、竞态、串行化逻辑,均通过纯逻辑单测覆盖:

 复制代码// core/documents/persistenceScheduler.js
// 保存状态机:防抖调度 + revision 防竞态 + Promise 链串行化写入。
// 存储实现(sa ve)与快照来源(getSnapshot)以参数注入,不依赖 Vue 与 DOM。
export const createPersistenceScheduler = ({
  getSnapshot,
  sa ve,
  canPersist,
  onStatus,
}) => {
  // ...
};

依赖注入贯穿整层:存储写入方式、快照获取方式,均作为参数传入。测试时只需替换为内存实现即可。

controllers:命令式能力的唯一访问入口

CodeMirror 6 和预览区的 DOM 操作本质上是命令式的:设置光标、滚动到某行、高亮某段。这些能力被封装进两个门面——EditorControllerPreviewController,它们是组件之下操作编辑器或预览的唯一入口。 EditorController 还承担多文档的 EditorState 缓存:每个文档拥有独立的撤销历史,切换文档时替换 state 而非重建编辑器。

workspace:响应式状态与横切编排层

workspace/ 持有全部响应式状态,按职责拆分为多个会话:文档会话(多文档 CRUD + 持久化)、搜索会话、布局会话(分栏宽度/折叠/目录宽度)、预览渲染会话等。跨子系统的流程——例如「搜索命中后定位到行并双侧高亮」「折叠编辑区时把按钮移入预览区头部」——集中在 orchestrations.js 中,不散落在组件里。 createWorkspace.js 负责将这一切组装起来,并通过 provide 下发。

components:仅负责 UI 的哑组件

最上层的组件通过 inject 获取工作区并直接消费,自身不含业务逻辑。工具栏、命令面板、目录、搜索面板等,都只是状态的投影和动作的转发。这套分层的收益在于:变更有明确的落点。例如添加一个「导出 HTML」功能,纯逻辑进入 services/exporter.js,动作挂到 workspace,组件加一个按钮,三层各改一处,互不渗透。

三、几个关键子系统的取舍

渲染搬到 Web Worker

Markdown 渲染(marked 解析 + 代码高亮 + 源行标注)对长文档来说开销较大,跑在主线程会卡顿输入。MarkView 将渲染整体搬进 Web Worker,从而保持主线程流畅:

 复制代码// workspace/markdownRenderer.js
// Markdown 渲染调度:优先用 Web Worker(渲染在后台线程,主线程不卡顿),
// Worker 不可用时动态 import 同步渲染降级(保持主 bundle 精简,仅降级时才加载)。
// 用递增序号丢弃过期结果,避免快速输入时旧结果覆盖新结果。

有三个细节值得一提:

  1. 降级路径:Worker 不可用时动态 import 同步渲染模块——降级代码不进主 bundle,只有真正降级时才加载;
  2. 序号防乱序:快速输入时会有多个渲染请求在途,用递增序号丢弃过期结果,保证旧结果不会覆盖新结果;
  3. 渲染是纯函数renderMarkdown.js 本身在 core 层,Worker 只是它的一个宿主。

滚动同步:锚点表 + 单调插值

编辑区和预览区的双向滚动同步,一直是 Markdown 工具的一个经典难题——两侧内容高度不成线性比例(一行 Markdown 可能渲染成一张大图)。MarkView 的做法是渲染时给块级元素标注源码行号,再据此构建锚点表:

 复制代码// core/sync/anchorMap.js
// 构建锚点表:pairs 是若干对已对齐的滚动偏移 { editor, preview }。
// 两端各加一个哨兵锚点,把文档顶部与底部钉在一起,使两侧能同时到达 0 和最大值。
// 只保留严格落在两侧滚动范围内、且在两个轴上都严格递增的锚点,
// 以保证每一段插值都是单调的。

锚点之间线性插值,配合「滚动主控方」标记防止两侧互相触发形成回环。这套逻辑同样是纯函数,边界情况(锚点乱序、超出滚动范围)全部有单测覆盖。

URL 分享:文档压缩进 hash

没有后端,分享怎么做?答案是 lz-string:

 复制代码// core/share/shareLink.js
export const encodeSharePayload = ({ name, content, anchor }) => {
  const payload = JSON.stringify({
    n: name || "",
    c: content || "",
    ...(anchor ? { a: anchor } : {}),
  });
  return compressToEncodedURIComponent(payload);
};

文档名和内容 JSON 序列化后用 lz-string 的 URI 变体压缩,直接放进 URL hash。链接自包含——打开即还原文档,还可以携带标题锚点直达某一节。hash 不会发往服务器,天然私密。

PWA:不止离线,还是文件处理器

除了常规的预缓存离线,MarkView 在 manifest 里注册了 file_handlers

 复制代码file_handlers: [
    {
        action: base,
        accept: { 'text/markdown': ['.md', '.markdown'] }
    }
],
launch_handler: {
    client_mode: ['focus-existing', 'auto']
}

安装为 PWA 后,它成为系统里 .md / .markdown 文件的处理器——双击文件,操作系统唤起 MarkView ,应用侧由 launchQueue 消费者接收文件句柄并导入为新文档。launch_handler 设为优先复用已有窗口,避免每次双击都新开实例。一个 Web 应用,就这样长出了一点「桌面应用」的质感。

四、工程化闭环

最后聊聊保证质量的一揽子配置。一条命令跑完全部校验:

 复制代码pnpm check   # lint + 格式检查 + 测试 + 构建
  • ESLint --max-warnings=0,警告即失败;
  • Prettier 统一格式;
  • Vitest 直测 core 层与 workspace 编排逻辑;
  • 最后跑一次生产构建,确保产物健康。

结语

MarkView 的经验,可以浓缩成三句话:

  1. 约束是设计的朋友——「零后端」逼出了图片内联、URL 分享、原生打印这些干净的方案;
  2. 纯逻辑下沉是可测试性的根基——core 层零 Vue 零 DOM,测试成本低到没有借口不写;
  3. 命令式的世界要有门面——CodeMirror 和 DOM 的复杂性被 controller 挡住,上层始终面对声明式接口。

关于多标签页打开时文档状态如何实时同步、编辑中的内容如何保证不被覆盖,那又是另一套有意思的机制,另外有一篇文章专门讨论这个话题。

来源:https://juejin.cn/post/7662691781213519908
上一篇TinyEngine 2.11新版本发布:AI进一步融入画布,Vue工程可一键转DSL 下一篇告别手写对话面板,TinyRobot Container组件一键装下整个AI聊天
本站内容用于信息整理与展示,如有侵权或内容问题请及时联系处理。

相关推荐

补充同频道和同主题内容,方便继续浏览更多相关内容。

同类最新

继续查看同栏目最近更新的文章。

更多
DOM中文本元素层级路径的精准定位方法
前端开发 · 2026-07-20

DOM中文本元素层级路径的精准定位方法

通过向上遍历至首个带id的祖先节点,同时记录每层子索引,构建唯一可复现的层级路径,可精确定位任意右键点击的文本元素在页面中的结构位置,该方案将DOM定位转化为树路径问题,性能稳定且适用于复杂嵌套结构。

Tailwind CSS响应式断点原理与文本尺寸类正确使用顺序
前端开发 · 2026-07-20

Tailwind CSS响应式断点原理与文本尺寸类正确使用顺序

TailwindCSS的响应式前缀基于min-width媒体查询,采用移动优先策略。无前缀类默认所有尺寸生效,带前缀类在达到对应断点后增强覆盖。正确写法应从小到大依次排列,避免大屏变小,确保移动端优先,逐步适配更大屏幕,断点尺寸依次递增。

Nuxt 3/Vue 3 v-for列表删除后UI状态错乱解决方案
前端开发 · 2026-07-20

Nuxt 3/Vue 3 v-for列表删除后UI状态错乱解决方案

在Nuxt3 Vue3中,v-for列表删除后UI状态错乱源于将数组索引作为key,导致DOM节点复用。正确做法是为每项数据赋予稳定唯一的id作为key,并确保key绑定在v-for所在元素上,避免使用索引,从而保证UI与数据同步。

独立控制每个可展开区域的展开折叠状态
前端开发 · 2026-07-20

独立控制每个可展开区域的展开折叠状态

在React中为多个同类型可展开区域实现独立开关控制,核心是将状态粒度从组件级下放到每个条目级,通过自定义Hook封装状态逻辑,使用唯一标识符而非数组索引管理展开状态,避免全局状态导致同步开闭,支持展开、收起和切换方法。

Ant Design自定义CSS主题编译耗时优化方案
前端开发 · 2026-07-20

Ant Design自定义CSS主题编译耗时优化方案

AntDesign自定义CSS主题编译慢的根源是Webpack每次完整解析整个index less。解决方法包括:配置less-loader缓存目录、modifyVars仅传需覆盖变量、避免动态@import路径、禁用cssinjs、主题变量通过构建时注入而非运行时计算,并同步更新alias less。