docs: add @render-policy/mermaid to community integrations by shteynu · Pull Request #8417 · mermaid-js/mermaid

shteynu · 2026-10-10T08:29:22Z

📑 Summary

Adds @render-policy/mermaid under Community integrations → LLM integrations. Disclosure: I maintain it.

Models emit ```mermaid blocks all the time, and chat UIs render them from untrusted text. This package renders them as a transform in render-policy:

mermaid always runs with securityLevel: 'strict' and no HTML labels;
the SVG goes through an SVG-only sanitizer;
the diagram lives in a shadow root, so it can't restyle or overlay the host page;
while a reply is streaming, an unclosed block stays a code block.

It uses mermaid 11+ as a peer dependency. MIT, on npm.

📏 Design Decisions

One line, added to the source file packages/mermaid/src/docs/ecosystem/integrations-community.md and mirrored in the generated docs/ copy. It goes in alphabetical order after Mermaid Studio.

📋 Tasks

📖 have read the contribution guidelines
💻 have added necessary unit/e2e tests. (n/a: docs only)
📓 have added documentation.
🦋 changeset (n/a: docs only, no package change)

🤖 Generated with Claude Code

Summary

Added @render-policy/mermaid to the LLM integrations list in both the source integrations document and its generated docs/ copy.
Described its strict mode, SVG-only sanitizer, shadow-root isolation, and streaming support.

Review findings

Severity counts are unavailable. No current review findings were supplied.
Test results and changeset status were not verified.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

changeset-bot · 2026-10-10T08:29:27Z

⚠️ No Changeset found

Latest commit: f88a135

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify · 2026-10-10T08:29:28Z

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	`f88a135`
🔍 Latest deploy log	https://app.netlify.com/projects/mermaid-js/deploys/6ac9f765dd8c1e000819b0f2
😎 Deploy Preview	https://deploy-preview-8417--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2026-10-10T08:29:43Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: 8bc53fae-9ab4-4428-a9dd-648ed979d877

📥 Commits

Reviewing files that changed from the base of the PR and between 33d0a49 and f88a135.

📒 Files selected for processing (2)

docs/ecosystem/integrations-community.md
packages/mermaid/src/docs/ecosystem/integrations-community.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

Walkthrough

The LLM integrations list now includes @render-policy/mermaid in two documentation copies. The entry describes strict mode, SVG-only sanitization, shadow-root isolation, and streaming support.

Changes

LLM integration documentation

Layer / File(s)	Summary
Add the integration to both lists `docs/ecosystem/integrations-community.md`, `packages/mermaid/src/docs/ecosystem/integrations-community.md`	Both lists include `@render-policy/mermaid` and describe its rendering features for LLM-generated Mermaid diagrams.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to f88a1

This documentation-only change is mergeable with normal checks; no actionable issue is established.

Pre-merge checks | 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check		The title clearly and concisely identifies the main documentation change: adding `@render-policy/mermaid` to the community integrations list.
Description check		The description includes the required Summary, Design Decisions, and Tasks sections. It explains the documentation-only scope, implementation details, author disclosure, test status, and changeset sta…
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

🧪 Generate unit tests (beta)

Create a new PR

🛠️ Fix failing CI checks 💡

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

⚠️ This pull request has been flagged as potential spam (promotional) by CodeRabbit slop detection and should be reviewed carefully.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

pkg-pr-new · 2026-10-10T08:30:54Z

Open in StackBlitz

@mermaid-js/examples

npm i https://pkg.pr.new/@mermaid-js/examples@8417

mermaid

npm i https://pkg.pr.new/mermaid@8417

@mermaid-js/layout-elk

npm i https://pkg.pr.new/@mermaid-js/layout-elk@8417

@mermaid-js/layout-tidy-tree

npm i https://pkg.pr.new/@mermaid-js/layout-tidy-tree@8417

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/@mermaid-js/mermaid-zenuml@8417

@mermaid-js/parser

npm i https://pkg.pr.new/@mermaid-js/parser@8417

@mermaid-js/tiny

npm i https://pkg.pr.new/@mermaid-js/tiny@8417

commit: f88a135

codecov · 2026-10-10T08:33:23Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.16%. Comparing base (33d0a49) to head (f88a135).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8417      +/-   ##
===========================================
- Coverage    81.15%   78.16%   -2.99%     
===========================================
  Files          622      622              
  Lines        86016    86016              
  Branches     16421    16421              
===========================================
- Hits         69803    67233    -2570     
- Misses       15207    17820    +2613     
+ Partials      1006      963      -43

Flag	Coverage Δ
e2e	`63.40% <ø> (-10.59%)`	⬇️
unit	`79.45% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.
see 127 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

argos-ci · 2026-10-10T08:40:18Z

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	418 added	Oct 10, 2026, 8:40 AM

docs: add @render-policy/mermaid to community integrations

f88a135

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

github-actions Bot added the Area: Documentation label Oct 10, 2026

Navigation Menu

Repository navigation

docs: add @render-policy/mermaid to community integrations - #8417

docs: add @render-policy/mermaid to community integrations#8417
shteynu wants to merge 1 commit into
mermaid-js:developfrom
shteynu:docs/add-render-policy-mermaid

shteynu commented Oct 10, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 10, 2026

Uh oh!

netlify Bot commented Oct 10, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 10, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 10, 2026

Uh oh!

codecov Bot commented Oct 10, 2026 •

edited

Loading

Uh oh!

argos-ci Bot commented Oct 10, 2026 •

edited

Loading

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

shteynu commented Oct 10, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Summary

📏 Design Decisions

📋 Tasks

Summary

Review findings

Uh oh!

changeset-bot Bot commented Oct 10, 2026

⚠️ No Changeset found

Uh oh!

netlify Bot commented Oct 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for mermaid-js ready!

Uh oh!

coderabbitai Bot commented Oct 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 10, 2026

Uh oh!

codecov Bot commented Oct 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

argos-ci Bot commented Oct 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

shteynu commented Oct 10, 2026 •

edited by coderabbitai Bot

Loading

netlify Bot commented Oct 10, 2026 •

edited

Loading

coderabbitai Bot commented Oct 10, 2026 •

edited

Loading

codecov Bot commented Oct 10, 2026 •

edited

Loading

argos-ci Bot commented Oct 10, 2026 •

edited

Loading