Tiptap 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.
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/:
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.
