🇺🇸English
Tiptap Integration Skill
Instructions for coding agents integrating the Tiptap rich text editor
Reference Repositories
Clone the tiptap and tiptap-docs repositories so you can search the source code and documentation.
If the workspace already has a reference folder with other repositories, clone them there.
Otherwise, clone the repositories in a new .reference folder. The reference folder should be git-ignored.
Before you start a task, make sure the repositories are updated to the latest version.
Best Practices
General
- Use the latest stable version of Tiptap 3.
- All packages that start with
@tiptap/ must have the same version number.
- When integrating Tiptap for the first time, read the corresponding installation guide in tiptap-docs.
- 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 tiptap-docs.
React
- Prefer using the React Composable API. See
tiptap-docs/src/content/guides/react-composable-api.mdx
Implementing Editor Features
When the user asks you to implement one of these features, read the corresponding section in tiptap-docs for guidance.
- Real-time collaboration — Multiple users editing a document simultaneously. See
tiptap-docs/src/content/collaboration/.
- Comments — Thread-based inline and document comments. See
tiptap-docs/src/content/comments/.
- Tracked changes — Track, accept, and reject document edits. See
tiptap-docs/src/content/tracked-changes/.
- Import/Export — Convert documents to and from DOCX, PDF, Markdown, and other formats. See
tiptap-docs/src/content/conversion/.
- AI content generation — Generate text content into the document using AI. See
tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/workflows/insert-content.mdx.
- AI agent document editing — Give an AI agent the ability to edit Tiptap documents. See
tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/.
Pro Extensions
Some Tiptap extensions are distributed through a private npm registry. To install pro packages, see tiptap-docs/src/content/guides/pro-extensions.mdx for setup instructions.
Weekly Installs
112
Repository
ueberdosis/tiptap
GitHub Stars
35.8K
First Seen
8 days ago
Security Audits
Gen Agent Trust HubPassSocketPassSnykWarn
Installed on
github-copilot100
kimi-cli99
gemini-cli99
amp99
cline99
codex99
