关于 tiptap
Tiptap integration 技能指导 Agent 根据项目中安装的 Tiptap 版本和任务选择文档与 API。它覆盖设置、协作、AI 功能和文档特性,并建议优先查阅本地源码与在线文档。
主要功能
- 01按任务加载相关文档
- 02依据已安装版本选择 API
- 03查阅本地 Tiptap 源码
- 04覆盖协作、AI 与文档功能
适用场景
- 01为应用配置 Tiptap 或升级依赖
- 02添加协作、版本历史或快照比较
- 03实现 AI 内容生成或文档编辑
- 04调试自定义扩展集成
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ ueberdosis/ tiptap --skill tiptap安装后在 Claude Code 中输入/tiptap确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/ai.mdcollaboration.mddocument-features.mdsetup.md详细介绍
Tiptap 集成
工作流
- 确定应用的框架、已安装的 Tiptap 版本以及所需功能。
- 在选择 API 之前,先阅读相关文档和已安装的源码。让实现与已安装版本保持一致,而不是依赖记忆中的示例。
- 只加载与下方任务相关的参考资料。对于未列出的主题,通过文档索引找到相关页面。
| 任务 | 参考资料 |
|---|---|
| 安装或升级包、选择 React API、配置 SSR,或安装 pro 扩展 | 安装与包 |
| 添加协作、版本历史或快照对比 | 协作与文档历史 |
| 添加 AI 生成、Agent 文档编辑,或迁移已停用的 AI 扩展 | AI 功能 |
| 添加评论、修订跟踪、文档转换或页面布局 | 文档功能 |
对于自定义扩展和集成调试,请查看相关的已安装 @tiptap/* 源码和文档。只有在主题适用时,才加载参考资料。
查找 Tiptap 源码和文档
避免克隆。通常你并不需要。
- 文档:在 https://tiptap.dev/docs 上任意页面 URL 后追加
.md,即可将其作为 Markdown 获取。https://tiptap.dev/docs/llms.txt列出了每个页面及其一行描述。 - 源码:如果项目已经依赖 Tiptap,请在
node_modules/@tiptap/*中阅读它。
只有在你无法通过上述任一方式获取源码或可运行示例时(例如 demos/src/ 下的演示应用),才进行克隆。浅克隆到工作区现有的参考文件夹,或新建一个被 git 忽略的 .reference/:
git clone --depth 1 --filter=blob:none https://github.com/ueberdosis/tiptap .reference/tiptap
绝不要克隆 tiptap-docs。站点本身就是接口。
克隆下来的 Tiptap 仓库是只读参考。其 AGENTS.md / CLAUDE.md 规则——changesets、fallow:audit、在 demos/src/ 下添加演示——适用于向 Tiptap 贡献代码,而不是用户的项目。绝不要用户仓库中遵循它们。
评论
支持 Markdown