Skip to content

feat: add nuxt-content-mermaid - #1588

Open
andy820621 wants to merge 1 commit into
nuxt:mainfrom
andy820621:feat/add-nuxt-content-mermaid
Open

feat: add nuxt-content-mermaid#1588
andy820621 wants to merge 1 commit into
nuxt:mainfrom
andy820621:feat/add-nuxt-content-mermaid

Conversation

@andy820621

@andy820621 andy820621 commented Aug 22, 2026

Copy link
Copy Markdown

🔗 Linked issue

Resolves #1580

📚 Description

Adds @barzhsieh/nuxt-content-mermaid to the Nuxt modules registry.

The module renders Mermaid code blocks from Nuxt Content Markdown as responsive
diagrams, with lazy loading, dark/light theme switching, custom renderers, and
toolbar controls.

Compatibility

  • Latest v3 supports Nuxt ^4.1.0 and @nuxt/content >=3.5.0 <4.0.0.
  • v2.2.3 remains available for Nuxt 3 and declares ^3.20.1 || ^4.1.0.

@github-actions

Copy link
Copy Markdown

We've flagged this as a potential contribution without a human behind it. We welcome the thoughtful use of AI tools when contributing, but ask all contributors to follow two core principles:

  1. Never let an LLM speak for you - all comments, issues, and PR descriptions should be written in your own words, reflecting your own understanding.
  2. Never let an LLM think for you - only submit contributions you fully understand and can explain.

Please review these AI-assisted contribution guidelines and update this contribution if needed.

If this was flagged in error, we apologise! 😳 Just let us know. 🙏

@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 975ea470-10b3-49c1-9dd2-1e9c0b62a3b1

📥 Commits

Reviewing files that changed from the base of the PR and between 165a4a4 and 235cec3.

⛔ Files ignored due to path filters (1)
  • icons/nuxt-content-mermaid.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • modules/nuxt-content-mermaid.yml

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

Adds a module metadata file for nuxt-content-mermaid. The metadata includes package details, repository and website links, classification, maintainer, description, and Nuxt 3/Nuxt 4 compatibility constraints.

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

Merge Risk: ⚪ Minimal · up to 235ce

This PR adds a localized module registry entry and icon, with no actionable merge-blocking risk remaining after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The metadata fulfills issue [#1580] by listing the module, repository, npm package, capabilities, and Nuxt 3 and Nuxt 4 compatibility.
Out of Scope Changes check ✅ Passed The pull request contains only the module metadata required to add nuxt-content-mermaid to the registry.
Docstring Coverage ✅ Passed 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 files. (1 skipped: 1 unsupported.)
Title check ✅ Passed The title clearly identifies the main change: adding nuxt-content-mermaid to the Nuxt modules registry.
Description check ✅ Passed The description explains the registry addition, module capabilities, and Nuxt compatibility.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@andy820621

andy820621 commented Aug 22, 2026

Copy link
Copy Markdown
Author

the autofix ci job's full-registry pnpm sync currently fails on the existing windicss entry because windicss/nuxt-windicss was archived on August 20.
The new nuxt-content-mermaid entry passes targeted sync locally, and all other checks pass.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Module Listing Request]: @barzhsieh/nuxt-content-mermaid

1 participant