About tiptap
Tiptap integration is a skill that guides agents to choose documentation and APIs based on the installed Tiptap version and task. It covers setup, collaboration, AI, and document features, with guidance to consult local source and online docs.
Key features
- 01Load documentation relevant to each task
- 02Choose APIs for the installed version
- 03Inspect local Tiptap source
- 04Cover collaboration, AI, and document features
Use cases
- 01Set up Tiptap or upgrade packages
- 02Add collaboration, version history, or snapshot comparison
- 03Implement AI generation or document editing
- 04Debug custom extension integrations
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ ueberdosis/ tiptap --skill tiptapAfter installing, type/tiptapin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/ai.mdcollaboration.mddocument-features.mdsetup.mdDetails
From the project READMETiptap integration
Workflow
- Identify the application's framework, installed Tiptap versions, and requested feature.
- Read the relevant documentation and installed source before choosing APIs. Match the implementation to the installed version rather than relying on remembered examples.
- Load only the references relevant to the task below. For topics not listed, find the relevant page through the documentation index.
| Task | Reference |
|---|---|
| Install or upgrade packages, choose a React API, configure SSR, or install pro extensions | Setup and packages |
| Add collaboration, version history, or snapshot comparison | Collaboration and document history |
| Add AI generation, agent document editing, or migrate retired AI extensions | AI features |
| Add comments, tracked changes, document conversion, or page layout | Document features |
For custom extensions and integration debugging, inspect the relevant installed @tiptap/* source and documentation. Load a reference only if its topic applies.
Finding Tiptap source and docs
Avoid cloning. You usually don't need to.
- Docs: append
.mdto any page URL on https://tiptap.dev/docs to fetch it as Markdown.https://tiptap.dev/docs/llms.txtlists 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/:
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.