Home

tiptap-markdown-react Wiki

一个 Markdown 优先的所见即所得编辑器 + 阅读器套件（基于 Tiptap v3）：Markdown 进，Markdown 出——外加目录、客户端预览、服务端（RSC/SSR）阅读渲染。无 UI 框架依赖，通过 CSS 变量主题化。

本 Wiki 承接深入文档。快速上手、安装与完整 API 表请看 README；可交互的编辑器 demo 见文档站。

文档地图

页面	内容
Markdown 往返规则	哪些语法原生往返、哪些走 HTML、哪些刻意偏离标准
架构与入口	三个入口的加载边界、服务端渲染管线、共享 tokenizer
性能与基准	长文档基准的方法、当前数据与复现命令
设计决策与已知边界	为什么 $ 是货币符、为什么没有合并单元格、付费组件边界
版本历史	每个发布的变更摘要
发布与贡献	构建、测试、发版流程与依赖规则

快速链接

• npm: tiptap-markdown-react
• 文档站（交互 demo）
• 问题反馈

使用前最该知道的三件事

1. 三个入口不要混用：编辑器用 tiptap-markdown-react，服务端渲染用 ./server，阅读页用 ./reader。同一客户端 bundle 里混用 . 与 ./server 会抛 Duplicate use of selection JSON ID cell —— 详见架构与入口。
2. 公式语法刻意偏离标准：内联公式是 $$E = mc^2$$ 而不是 $x$，单个 $ 永远是货币符——详见设计决策与往返规则。
3. 样式只在用到时才写 HTML：图片缩放/对齐/图注、段落样式没有 markdown 语法，导出为 HTML 标签，但未触碰的内容永远保持原生 markdown——详见往返规则。