Skip to content

Document the richtext extension API - #848

Open
alvarosabu wants to merge 2 commits into
mainfrom
docs/richtext-extension-guide
Open

alvarosabu wants to merge 2 commits into
mainfrom
docs/richtext-extension-guide

Conversation

@alvarosabu

Copy link
Copy Markdown
Contributor

The Rich Text Extensions page now documents the full extension API. Before, it had only the Tiptap version policy.

  • Documents the defineRichText config, toolbar buttons and bubble menus.
  • Documents per-field enablement, load order, the round-trip rule, name validation and error handling.
  • Documents node views with useRichTextEditable(), CSS scoped under .richtext-content, removed extensions, and wrapped Tiptap packages.
  • Changes the host example to ^12.6.0.

Review Notes

  • The YouTube example in "Wrap an Existing Tiptap Package" is not tested yet.
  • Per-extension field options (CMS-3101) and $t: labels (CMS-3102) are not documented. They are still in review.

Test plan

  • Open /docs/guides/extensions/app-extensions/richtext and check that the page renders.
  • Check the Extensions row in /docs/guides/data-model/interfaces#wysiwyg.

Closes CMS-3098

@vercel

vercel Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 20, 2026 9:05am UTC

Request Review

@linear-code

linear-code Bot commented Oct 19, 2026

Copy link
Copy Markdown

CMS-3098

The entrypoint example is now a note block, and the YouTube example uses the id youtube-embed. The published callout and YouTube example packages use the ids callout and youtube.
The YouTube example now uses the named import and a focused command chain, like the example package.

This branch was successfully deployed

1 active deployment
Preview — adf7b1ee Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant