zhravan/zen-mdx-blog

feat: support for mermaid diagram

Open

#11 opened on Oct 22, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6 forks)auto 404
enhancementgood first issuehacktoberfesthacktoberfest-acceptedhacktoberfest2025help wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Descrioption

Add support for Mermaid.js diagrams in MDX content for flowcharts, sequence diagrams, and other visualizations.

Things to take care of:

  • Integrate mermaid library
  • Custom MDX component or remark plugin
  • Support common diagram types
  • Theme-aware styling
  • Lazy loading for performance

Contributor guide

Research direction
Investigate how to integrate Mermaid.js into MDX content, create a custom component or remark plugin, and implement lazy loading.
Tech stack
typescriptjavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptReact
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60