mcpField
T
tiptap-dev

tiptap-dev

github.com/xiaolai开发87879 次安装今天更新
代码仓库

关于 tiptap-dev

面向 Tiptap 开发者的通用编辑器开发技能，涵盖扩展、命令、模式和 React 集成。它基于 ProseMirror，适用于构建自定义富文本编辑器功能。

主要功能

  1. 01创建节点、标记和扩展
  2. 02配置输入规则与粘贴规则
  3. 03使用可链式编辑器命令
  4. 04集成 React 的 useEditor
  5. 05理解模式与内容结构

适用场景

  1. 01为编辑器添加自定义节点或格式
  2. 02实现输入和粘贴转换规则
  3. 03在 React 应用中创建 Tiptap 编辑器
  4. 04扩展现有 Tiptap 扩展

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/xiaolai/vmark --skill tiptap-dev

安装后在 Claude Code 中输入/tiptap-dev确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
commands-and-api.md
examples.md
extensions.md
input-paste-rules.md
react-integration.md
schema.md

详细介绍

Tiptap 开发专家

为使用 Tiptap 构建富文本编辑器提供专家指导——Tiptap 是一个基于 ProseMirror 构建的无头、与框架无关的编辑器。

另请参阅： tiptap-editor 技能——VMark 专属的 Tiptap API 模式（命令、节点遍历、选区处理）。通用 Tiptap/ProseMirror 开发请使用 tiptap-dev，VMark 专属的编辑器集成请使用 tiptap-editor。

何时使用此技能

  • 为 Tiptap 创建自定义节点、标记或扩展
  • 实现输入规则或粘贴规则
  • 使用 Tiptap 命令 API
  • 使用 useEditor 构建 React 集成
  • 扩展现有扩展
  • 创建自定义节点视图
  • 了解架构和内容模型

参考文件

文件描述
references/extensions.md扩展类型（Node、Mark、Extension）及创建模式
references/commands-and-api.md命令 API、编辑器 API、链式调用
references/input-paste-rules.md输入规则和粘贴规则
references/react-integration.mdReact 专属钩子和组件
references/schema.md架构属性、内容模式
references/examples.md完整的可运行示例

快速参考

扩展类型
// Functionality extension (no schema)
Extension.create({ name: 'myExtension', addKeyboardShortcuts() { ... } })

// Node extension (block content)
Node.create({ name: 'myNode', group: 'block', content: 'inline*' })

// Mark extension (inline formatting)
Mark.create({ name: 'myMark', parseHTML() { ... }, renderHTML() { ... } })
命令链式调用
editor.chain().focus().toggleBold().run()
editor.can().chain().focus().toggleBold().run() // dry run
React 集成
const editor = useEditor({
  extensions: [StarterKit],
  content: '<p>Hello</p>',
  immediatelyRender: false, // for SSR
})

核心概念

  1. 无头架构：Tiptap 提供逻辑，渲染由你控制
  2. 基于扩展：所有功能都是扩展（节点、标记、功能）
  3. ProseMirror 基础：基于 ProseMirror 构建，可全面使用其 API
  4. 架构驱动：内容模型由节点/标记架构定义
  5. 命令模式：所有操作均通过可链式调用的命令完成

评论

支持 Markdown