agentleFS
fjrevoredofjrevoredo/mini-diarium/.agents/skills/tiptap/SKILL.md

tiptap

Skill321 starsChanged 6 days agoMITView on GitHub

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.

4 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 5 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the workspace already has a reference folder with other repositories, clone them there.

    line 21
  2. Distinctive:

    Before you start a task, make sure the repositories are updated to the latest version.

    line 25
  3. Distinctive:

    Use the latest stable version of Tiptap 3.

    line 31
  4. Very specific:

    All packages that start with @tiptap/ must have the same version number.

    line 32
  5. Distinctive:

    When integrating Tiptap for the first time, read the corresponding installation guide in tiptap-docs.

    line 33
  6. Very specific:

    When server-side rendering (e.g.

    line 34
  7. Very specific:

    Prefer using the React Composable API.

    line 38
  8. Distinctive:

    When the user asks you to implement one of these features, read the corresponding section in tiptap-docs for guidance.

    line 42

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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/.
  • AI review and proofreading — Review, proofread, and suggest style improvements. See tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/workflows/proofreader.mdx.
  • AI server-side processing — Run AI workflows that edit rich text documents on the server. See tiptap-docs/src/content/content-ai/capabilities/server-ai-toolkit/.
  • Version history — Save and restore document snapshots. See tiptap-docs/src/content/collaboration/documents/snapshot.mdx.
  • Snapshot compare — Highlight differences between document versions. See tiptap-docs/src/content/collaboration/documents/snapshot-compare.mdx.
  • Pages — Print-ready page layout with headers, footers, and page breaks. See tiptap-docs/src/content/pages/.

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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.