Item logo image for GitHub Mermaid JSDoc Viewer

GitHub Mermaid JSDoc Viewer

ExtensionDeveloper Tools5 users
Item media 3 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 1 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 2 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 3 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 1 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 1 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 2 (screenshot) for GitHub Mermaid JSDoc Viewer
Item media 3 (screenshot) for GitHub Mermaid JSDoc Viewer

Overview

Open and preview Mermaid diagrams found in JSDoc comments while browsing source files on GitHub.

## Why Documenting architecture or flow logic with a ` ```mermaid ` block inside a JSDoc comment is a nice way to keep diagrams next to the code they describe — but GitHub only renders it as a fenced code block, not a diagram, whether you're reading the source or reviewing a diff. This extension adds a small badge next to the line number of every such block so you can preview or open the diagram without leaving the page or copy-pasting into an external tool. --- ## Features - Scans `/** ... */` JSDoc comments in `.js`/`.jsx`/`.ts`/`.tsx` files, and plain fenced blocks in `.md`/`.markdown`/`.mdx` files, for ` ```mermaid ` code blocks — on blob (source file) pages, and on PR "Files changed", commit and compare diff pages - Overlays a small 📊 badge next to the line number of each detected block; click it to open a zoomable/pannable preview (via [mermaid.ink](https://mermaid.ink)), which also links to the full mermaid.live editor - On diff pages, if the diagram _itself_ was edited (not just surrounding code), the badge turns into 🔀 and clicking it shows the diagram **before and after side by side** — a red-tinted "Before" pane and a green-tinted "After" pane, each with its own "Open in Mermaid Live" link - Preview supports scroll-to-zoom, drag-to-pan, double-click-to-reset, and a +/−/⟳ toolbar - Works on GitHub's Turbo-driven navigation and lazy-loaded diffs — badges refresh automatically as you browse between files or scroll - Light and dark mode support

Details

  • Version
    1.0.0
  • Updated
    September 4, 2026
  • Size
    48.38KiB
  • Languages
    English (United States)
  • Developer
    Email
    guillaume.ongenae@gmail.com
  • Non-trader
    This developer has not identified itself as a trader. For consumers in the European Union, please note that consumer rights do not apply to contracts between you and this developer.

Privacy

Manage extensions and learn how they're being used in your organization
The developer has disclosed that it will not collect or use your data. To learn more, see the developer’s privacy policy.

This developer declares that your data is

  • Not being sold to third parties, outside of the approved use cases
  • Not being used or transferred for purposes that are unrelated to the item's core functionality
  • Not being used or transferred to determine creditworthiness or for lending purposes

Support

For help with questions, suggestions, or problems, visit the developer's support site

Google apps