@paulyellow/tiptap-markdown-editor

tiptap-markdown-editor

一个基于 Vue 3 + TipTap 的所见即所得 Markdown 编辑器，支持 ECharts 图表、表格、Slash 命令菜单等功能。

功能特性

• Slash 命令菜单 - 输入 / 快速切换块类型（标题、列表、引用、代码块等）
• 块级添加按钮 - 鼠标悬停显示 + 按钮快速插入新块
• 富文本工具栏 - 选中文字后自动显示格式化工具栏（字体、颜色、对齐等）
• 表格编辑 - 支持插入表格、行列增删
• ECharts 图表 - 支持代码块渲染图表和独立图表节点
• Markdown 输入规则 - # 创建标题、- 创建列表、> 创建引用
• 导出 PDF / DOCX - 一键导出文档
• 中文默认字体 - 正文默认仿宋、一级标题默认黑体

安装

npm install tiptap-markdown-editor
# 或
yarn add tiptap-markdown-editor
# 或
pnpm add tiptap-markdown-editor

快速开始

<template>
  <MarkdownEditor
    ref="editorRef"
    v-model="content"
    height="600px"
    placeholder="开始编辑..."
  />
</template>

<script setup>
import { ref } from 'vue'
import { MarkdownEditor } from 'tiptap-markdown-editor'
import 'tiptap-markdown-editor/style.css'

const content = ref('# 你好，世界')
const editorRef = ref(null)

// 获取 Markdown 内容
const getMd = () => editorRef.value?.getMarkdown()

// 获取 HTML 内容
const getHtml = () => editorRef.value?.getHtml()

// 获取 TipTap Editor 实例
const getEditor = () => editorRef.value?.editor()
</script>

组件 API

MarkdownEditor

暴露的方法

通过 ref 调用：

ExportPdfBtn

<template>
  <ExportPdfBtn :editor="editorRef?.editor()" />
</template>

ExportDocxBtn

<template>
  <ExportDocxBtn :editor="editorRef?.editor()" />
</template>

完整导出列表

// 组件
import { MarkdownEditor, ExportPdfBtn, ExportDocxBtn } from 'tiptap-markdown-editor'

// 扩展组件
import {
  EChartsNode,
  CodeBlockWithCharts,
  MarkdownInputRules,
  SlashMenuExtension,
  BlockButtonsExtension,
  initBlockButtons,
  updateBlockButtons,
  Table,
  TableRow,
  TableHeader,
  TableCell,
  FontFamily,
  TextStyle,
  Color,
  TextAlign,
  BulletList,
  OrderedList,
  ListItem
} from 'tiptap-markdown-editor'

// 工具函数
import { menuItems, slashAction, plusAction, exportToPdf } from 'tiptap-markdown-editor'

自定义 Slash 菜单

import { MarkdownEditor, menuItems, slashAction, plusAction } from 'tiptap-markdown-editor'

// menuItems 可自定义或扩展
// 每个菜单项格式：
// {
//   label: '标题 1',
//   desc: '大章节标题',
//   icon: 'h1',
//   keywords: '标题 headings h1',
//   command: (editor) => slashAction(editor, 'setHeading', { level: 1 }),
//   plusCommand: (editor) => plusAction(editor, 'setHeading', { level: 1 })
// }

导出工具

import { exportToPdf } from 'tiptap-markdown-editor'

// 直接调用导出
exportToPdf(editorDomElement, 'document.pdf')

流式输出

当对接 AI 模型（如 LLM）的流式输出时，启用 streaming 属性可以显著提升性能：

<MarkdownEditor
  ref="editorRef"
  v-model="content"
  :streaming="true"
/>

为什么需要 streaming 模式？

启用 streaming 后：

• 编辑器自动检测新增内容，只插入增量部分
• 避免频繁全量替换导致的 DOM 重绘
• 光标位置不会被重置
• 支持逐字符/逐块的打字机效果

依赖要求

本组件需要以下 peer dependencies，请确保在项目中安装：

{
  "@tiptap/core": "^3.22.4",
  "@tiptap/extension-text-style": "^3.22.4",
  "@tiptap/vue-3": "^3.22.4",
  "vue": "^3.5.0"
}

License

MIT