Installation

Mermaid Studio can be installed from the JetBrains Marketplace directly within your IDE, or downloaded manually.

Install from IDE (Recommended)

1. Open your JetBrains IDE (IntelliJ IDEA, WebStorm, PyCharm, etc.)

2. Open Settings (or Preferences on macOS):

   • Windows/Linux: File → Settings
   • macOS: IntelliJ IDEA → Preferences (or ⌘,)

3. Navigate to Plugins → Marketplace

4. Search for “Mermaid Studio”

5. Click Install

6. Restart your IDE when prompted

Install from JetBrains Marketplace Website

1. Visit the Mermaid Studio plugin page on the JetBrains Marketplace

2. Click Install to IDE and select your IDE

3. Your IDE will open and prompt you to install the plugin

4. Restart your IDE when prompted

Install from Disk (Manual)

For offline installation or testing pre-release versions:

1. Download the plugin .zip file from:

   • GitHub Releases
   • Or build from source

2. Open Settings → Plugins

3. Click the ⚙️ gear icon and select Install Plugin from Disk…

4. Select the downloaded .zip file

5. Restart your IDE

System Requirements

• IDE Version: IntelliJ IDEA 2024.1 or later (or equivalent version for other JetBrains IDEs)
• Platform: Windows, macOS, or Linux
• Java: Bundled with IDE (no separate installation required)

Verify Installation

After installation, verify Mermaid Studio is working:

1. Create a new file with .mmd or .mermaid extension (e.g., diagram.mmd)

2. Type the following:

   flowchart TD
       A[Start] --> B[End]

3. You should see:

   • Syntax highlighting for keywords and nodes
   • A preview panel showing the rendered diagram

Troubleshooting

Plugin not appearing after installation

• Ensure you’ve restarted your IDE completely
• Check Settings → Plugins → Installed to verify the plugin is enabled
• Check the IDE log for errors: Help → Show Log in Finder/Explorer

Preview panel not showing

• Open the preview with View → Tool Windows → Mermaid Preview
• Or right-click in the editor and select Show Mermaid Preview

Syntax highlighting not working

• Verify the file has a recognized extension (.mmd, .mermaid)
• Check that the plugin is enabled in Settings → Plugins → Installed

---

Next: Create your first diagram