Mermaid Diagram Sync installs statistics

Mermaid Diagram Sync Assistant

Keep Mermaid diagrams automatically in sync with source code changes in pull requests.

Mermaid Diagram Sync Assistant is an intelligent GitHub app that updates Mermaid diagrams when related source files are modified. When a PR is opened, synchronized, or reopened, the app scans the changed files, finds connected diagrams, regenerates the affected diagrams, and adds the updates back to the PR with clear bot attribution — so your docs stay current during review.

Mermaid Diagram Sync Assistant

Automatically keep Mermaid diagrams in sync with code changes in pull requests.

Getting Started

1. Install GitHub App

• Visit the app page on GitHub • Click Install and select your account/org • Choose repositories (all or specific) • Complete the OAuth flow

1. Connect Mermaid Chart Account

• If already logged in: connection happens instantly • If not: log in, then accounts link automatically

1. Verify Connection

Go to /app/github in Mermaid Chart to:

• View linked GitHub installations • Manage repo access • Track AI credit usage

Account Switching

To switch Mermaid Chart accounts, you must reinstall:

• Uninstall the GitHub App • Clear existing connections • Reinstall the app • Log in with a different account during OAuth • Verify in dashboard

Notes:

• No built-in logout/switch feature • One GitHub installation = one Mermaid account • Reinstalling doesn’t affect diagrams/repos • Credits stay with their respective accounts

.mermaidignore

Controls which files/diagrams are processed.

Features:

• Ignore source files or .mmd diagrams • Gitignore-style syntax (*, **, ?) • Negation with ! • Later rules override earlier ones

Example:

.log build/ node_modules/ /test !src/tests/integration.test.js draft//.mmd !temp-important.mmd

.smart-mermaid-updates.yml

Controls which PR branches are processed.

Features:

• Exclude branches via patterns • Supports wildcards and negation • If matched, PR is skipped

Example:

excludeBranches:

• experimental
• draft/*
• "*"
• "!feature/*"
• "!main"

Example Workflow

If you update UserService.js and AuthController.js:

• Bot detects changes • Finds related diagram • Updates it with new logic (e.g., 2FA flow) • Commits update to PR

Result: Documentation stays aligned with code before review.