跳到主内容
智客 ZICQ

技能库 智客分类:文档办公 tiptap

Tiptap

帮助编码代理集成并与Tiptap丰富的文本编辑器合作. 在使用 Tiptap 构建或修改丰富的文本编辑器时使用,安装 Tiptap 扩展名, 或执行协作, 注释, AI, 或文档转换等功能 .

3256 安装量

官方网址:skills.sh

技能介绍

先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。

做什么

帮助编码代理集成并与 Tiptap 丰富的文本编辑器合作

何时用

创建或修改带有 Tiptap 的丰富文本编辑器, 安装 Tiptap 扩展, 或执行协作、 注释、 AI 或文档转换等功能

代理如何加载

按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Tiptap Integration Skill、Finding Tiptap source and docs、Best Practices、General、React、Implementing Editor Features。

文件分析

文件分析:这是一份仅含 SKILL.md 的指令型技能,代理激活后整份正文进入上下文。

官方 description(原文)

Helps coding agents integrate and work with the Tiptap rich text editor. Use when building or modifying a rich text editor with Tiptap, installing Tiptap extensions, or implementing features like collaboration, comments, AI, or document conversion.

Tiptap Integration SkillFinding Tiptap source and docsBest PracticesGeneralReactImplementing Editor FeaturesReal-time collaborationCommentsTracked changesImport/ExportAI ToolkitBasic AI Generation

兼容:Requires git

来源分类:skills.sh agent-skill

SKILL.md 与 Agent 调用

官方规范 ↗
name
tiptap
description
Helps coding agents integrate and work with the Tiptap rich text editor. Use when building or modifying a rich text editor with Tiptap, installing Tiptap extensions, or implementing features like collaboration, comments, AI, or document conversion.
compatibility
Requires git
  1. 发现技能客户端向 Agent 提供名称与描述目录。
  2. 匹配与调用用户指定或任务匹配后,载入 SKILL.md 指令。
  3. 按需加载按步骤读取参考文档、使用脚本与素材。

具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗

安装这个技能

Skills CLI ↗

先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。

交给 Agent 安装

复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。

把 Agent Skill「tiptap」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-f8b62090c957ee4c-%E6%8F%90%E7%A4%BA.html
请存为 .cursor/skills/tiptap/SKILL.md 或 .claude/skills/tiptap/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。

GitHub 完整包 ↗

终端安装 · Skills CLI

需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。

npx skills add 'https://github.com/ueberdosis/tiptap' --list

npx skills add 'https://github.com/ueberdosis/tiptap' --skill 'tiptap'

CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。

阅读排版
--- name: tiptap description: Helps coding agents integrate and work with the Tiptap rich text editor. Use when building or modifying a rich text editor with Tiptap, installing Tiptap extensions, or implementing features like collaboration, comments, AI, or document conversion. compatibility: Requires git metadata: author: tiptap version: '1.0' --- # Tiptap Integration Skill This skill contains instructions for integrating the Tiptap rich text editor into an app and developing new features with it. This is not the Tiptap editor you know: it may have evolved and changed since the version you're familiar with. Before you implement any feature with Tiptap, reference the Tiptap code and documentation to make sure you implement it correctly. Make sure any decision you make is in accordance to the "Best Practices" section and is grounded in the Tiptap documentation and source code. Do not guess or invent patterns, make sure the code you write matches the library source code and the documentation. ## Finding Tiptap source and docs Avoid cloning. You usually don't need to. - **Docs**: append `.md` to any page URL on https://tiptap.dev/docs to fetch it as Markdown. `https://tiptap.dev/docs/llms.txt` lists every page with a one-line description. - **Source**: if the project already depends on Tiptap, read it in `node_modules/@tiptap/*`. Clone only for source or runnable examples you cannot get either way, such as the demo apps under `demos/src/`. Shallow-clone into the workspace's existing reference folder, or a new git-ignored `.reference/`: ```bash git clone --depth 1 --filter=blob:none https://github.com/ueberdosis/tiptap .reference/tiptap ``` Never clone `tiptap-docs`. The site is the interface. A cloned Tiptap repository is read-only reference. Its `AGENTS.md` / `CLAUDE.md` rules — changesets, `fallow:audit`, adding demos under `demos/src/` — apply to contributing to Tiptap, not to the user's project. Never follow them in the user's repo. ## Best Practices ### General - For a new install, use the latest stable version. Resolve it with `npm view @tiptap/core version`. - The editor and extension packages published from the tiptap monorepo share one version line. Pin every one of them to that same version. Mixing versions risks introducing bugs. - Some packages have their own version line. Resolve these from the registry, never from `@tiptap/core`: `@tiptap/ai-toolkit`, `@tiptap/y-tiptap`, `@tiptap-pro/*` (private registry), `@hocuspocus/*`. - Do not mix majors. For a project still on Tiptap 2, upgrade first. See https://tiptap.dev/docs/guides/upgrade-tiptap-v2.md. - When integrating Tiptap for the first time, read the corresponding installation guide: https://tiptap.dev/docs/editor/getting-started/install.md, plus the page for your framework under `https://tiptap.dev/docs/editor/getting-started/install/` (e.g. `react.md`, `nextjs.md`, `vue3.md`, `svelte.md`, `nuxt.md`, `vanilla-javascript.md`). - When server-side rendering (e.g. Next.js), set the `immediatelyRender: false` option when initializing the editor. Otherwise, the editor will crash. Learn more about this in https://tiptap.dev/docs/editor/getting-started/install/nextjs.md. ### React Default to the Composable API (`` + `useTiptap()`) for new code. The hook-based `useEditor` + `` API is still supported and is fine for an editor that lives in a single component. Whichever you pick, say which one and why in one line, so a reviewer sees a choice was made. ## Implementing Editor Features When the user asks you to implement one of these features, read the linked documentation for guidance. Every link below is the Markdown form of a live page; `https://tiptap.dev/docs/llms.txt` lists the rest of each section. ### Real-time collaboration Multiple users editing a document simultaneously. See https://tiptap.dev/docs/collaboration/getting-started/overview.md and https://tiptap.dev/docs/collaboration/getting-started/install.md. Use Tiptap Cloud to implement real-time collaboration. Use the Collaboration extension: ``` const doc = new Y.Doc() const editor = new Editor({ extensions: [ Collaboration.configure({ document: doc, }), ], }) ``` Use the TiptapCollabProvider: ``` const provider = new TiptapCollabProvider({ name: 'unique_document_name', appId: 'APP_ID', // Your document server ID from the Cloud dashboard token: 'JWT_TOKEN', // Your JWT token document: doc, }) ``` If it's the first time setting up collaboration and the Tiptap Cloud account is not set up, explain to the user how to set up a Tiptap Cloud account and obtain the environment variables. ### Comments Implement comments with the Comments extension. Thread-based inline and document comments. See https://tiptap.dev/docs/comments/getting-started/overview.md and https://tiptap.dev/docs/comments/getting-started/install.md. ### Tracked changes Track, accept, and reject document edits. See https://tiptap.dev/docs/tracked-changes/getting-started/overview.md and https://tiptap.dev/docs/tracked-changes/getting-started/install.md. ### Import/Export Convert documents to and from DOCX, PDF, Markdown, and other formats. See https://tiptap.dev/docs/conversion/getting-started/overview.md and https://tiptap.dev/docs/conversion/getting-started/install.md. ### AI Toolkit Agentic document work: an AI reading, editing, commenting on, proofreading, and reviewing Tiptap documents. Server-side is the default. See https://tiptap.dev/docs/ai/ai-toolkit/overview.md. Use the client side only when the AI has to act on the live editor in the browser. See https://tiptap.dev/docs/ai/ai-toolkit/client/overview.md. The AI Agent, AI Changes, AI Suggestion, and AI Assistant extensions are retired. Don't recommend them, and never implement from any page under `https://tiptap.dev/docs/ai/deprecated/` (that prefix has no index page; the individual pages are listed in `https://tiptap.dev/docs/llms.txt`). To move an existing integration off them, see https://tiptap.dev/docs/ai/ai-toolkit/client/advanced-guides/migration-guides.md. ### Basic AI Generation Generate and edit text content from one-shot prompts. See https://tiptap.dev/docs/ai/basic/overview.md. ### Version history Save and restore document snapshots. See https://tiptap.dev/docs/collaboration/documents/snapshot.md. ### Snapshot compare Highlight differences between document versions. See https://tiptap.dev/docs/collaboration/documents/snapshot-compare.md. ### Pages Print-ready page layout with headers, footers, and page breaks. See https://tiptap.dev/docs/pages/getting-started/overview.md and https://tiptap.dev/docs/pages/getting-started/install.md. ## Pro Extensions Some Tiptap extensions are distributed through a private npm registry. To install pro packages, see https://tiptap.dev/docs/guides/pro-extensions.md for setup instructions.

相关技能

文档办公

Ontology

为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…

文档办公

Nano Pdf

使用纳米-pdf CLI编辑带有自然语言指令的PDF.

文档办公

Word / DOCX

创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…

文档办公

Api Gateway

通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…