feat: add support for tiptap / liveblocks comments

[YousefED]

This PR:

• adds an "add comment" button to the Formatting Toolbar if a commenting plugin has been registered on TipTap
• adds a support to tag certain Marks that are not relevant for BlockNote, such as Marks. TipTap / Liveblocks comment plugins currently rely on marks to associate Comments as annotations to the document, even though they're not really document content. By tagging Marks as blocknoteIgnore it's possible to use these marks while not affecting the rest of BlockNote. In Tiptap, this can be done like this:

Mark.create(
...

extendMarkSchema(extension) {
    if (extension.name === "comment") { // "comment" is the name of the mark
      return {
        blocknoteIgnore: true,
      };
    }
    return {};
  }
...

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
blocknote	✅ Ready (Inspect)	Visit Preview	Feb 17, 2025 6:24pm
blocknote-website	✅ Ready (Inspect)	Visit Preview	Feb 17, 2025 6:24pm

[nperez0111]

Could we store something else in the spec rather than using the group for this?

Or maybe by the mark's name?

This feels kind of wrong to use the group for this

[YousefED]

fair. Prefer just to add anything else on the spec? (i.e.: (mark.type.spec as any).blocknoteIgnore = true)?

[nperez0111]

Yea, looks like the type should be already be open to allowing that sort of modifcation:

    /**
    Mark specs can include additional properties that can be
    inspected through [`MarkType.spec`](https://prosemirror.net/docs/ref/#model.MarkType.spec) when
    working with the mark.
    */
    [key: string]: any;
}

[YousefED]

nice, and it can be added in tiptap with:

extendMarkSchema(extension) {
    if (extension.name === "comment") { // if "comment" is the name of the comment mark
      return {
        blocknoteIgnore: true,
      };
    }
    return {};
  },

[nperez0111]

Nice, much cleaner!