Skip to content

Add addRichTextBlocks to Content Manager API documentation#3100

Open
butcherZ wants to merge 2 commits intomainfrom
doc/add-rich-text-blocks-customization-api
Open

Add addRichTextBlocks to Content Manager API documentation#3100
butcherZ wants to merge 2 commits intomainfrom
doc/add-rich-text-blocks-customization-api

Conversation

@butcherZ
Copy link
Copy Markdown
Member

@butcherZ butcherZ commented Apr 28, 2026

What does it do?

Documents the new addRichTextBlocks API added to the Content Manager plugin in strapi/strapi (feat/rich-text-blocks-customization).

Why is it needed?

The API allows Strapi applications and plugins to register custom block types in the Blocks rich text field. Without documentation, developers have no reference for how to use it.

Changes

  • cms/plugins-development/content-manager-apis: Adds a new ### addRichTextBlocks section documenting the API, its 2 call signatures (object and function), and a full block definition property table. Updates the <Tldr> to mention the new API.
  • cms/admin-panel-customization/wysiwyg-editor: Adds a note clarifying this page covers the markdown WYSIWYG editor, with a cross-reference to addRichTextBlocks for the Blocks field.

How to test it?

Review the rendered output on the preview deployment.

Related issue(s)/PR(s)

CMS-637

strapi/strapi#22063

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

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

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment May 4, 2026 9:20am

Request Review

@github-actions github-actions Bot added pr: updated content PRs updating existing documentation content source: CMS internal PRs created by the Strapi core team labels Apr 28, 2026
@butcherZ butcherZ requested a review from pwizla April 28, 2026 10:33
Comment thread docusaurus/docs/cms/plugins-development/content-manager-apis.md Outdated
Comment thread docusaurus/docs/cms/plugins-development/content-manager-apis.md Outdated
Comment thread docusaurus/docs/cms/plugins-development/content-manager-apis.md Outdated
…key handler example to addRichTextBlocks docs
@butcherZ butcherZ force-pushed the doc/add-rich-text-blocks-customization-api branch from e58894e to f4c4443 Compare May 4, 2026 09:19
@butcherZ butcherZ requested a review from pwizla May 4, 2026 09:26
Copy link
Copy Markdown
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, now! Thank you, Ziyi! 🚀

@pwizla pwizla changed the title docs(content-manager): add addRichTextBlocks API documentation Add addRichTextBlocks to Content Manager API documentation May 4, 2026
@pwizla pwizla added this to the 6.24.0 milestone May 4, 2026
@pwizla pwizla self-assigned this May 4, 2026
@pwizla pwizla added the flag: merge pending release Pending Strapi Release label May 4, 2026
@pwizla pwizla modified the milestones: 6.24.0, 6.25.0 May 6, 2026
@pwizla
Copy link
Copy Markdown
Collaborator

pwizla commented May 6, 2026

FYI, postponed to next week's docs milestone, since I've noticed your PR is included in 5.45.1, and not 5.45.0 that was released today. Thank you, @butcherZ!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

flag: merge pending release Pending Strapi Release internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: CMS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants