Plugins

JetBrains IDE

The Mermaid Chart extension for JetBrains IDEs enables developers to view and edit diagrams stored in Mermaid Chart within the IDE. With integration to the Mermaid Chart service, this extension allows users to attach diagrams to their code. Gain quick access to read and edit diagrams.

Compatible with IntelliJ IDEA (Ultimate, Community), Android Studio, AppCode, Aqua, CLion, Code With Me Guest, DataGrip, DataSpell, GoLand, JetBrains Client, JetBrains Gateway, MPS, PhpStorm, PyCharm (Professional, Community), Rider, RubyMine, RustRover, and WebStorm.

Download

Download the plugin from the JetBrains Marketplace.

Features

The Mermaid Chart extension offers the following features:

• Attach diagrams into your code, highlighted with an icon in the footer.

• Two links associated with each diagram: one for viewing the diagram in a new tab within IntelliJ IDEA, and another for editing the diagram in Mermaid Chart.

• Quickly consume and update diagrams as needed.

Requirements

The Mermaid Chart extension seamlessly integrates with the Mermaid Chart service. To use the extension, you need an account. You can choose between the Free tier, which is limited to 5 diagrams, or the Pro tier with unlimited diagrams. Collaborate with your development organization by setting up teams and sharing diagrams, simplifying diagram management, and enhancing your workflow with Mermaid Chart for IntelliJ IDEA.

Extension Settings

The Mermaid Chart extension contributes the following settings:

• mermaidChart.baseUrl

• This setting points to the instance of Mermaid Chart you are running. For the public service, the base URL is https://mermaid.ai/.

• mermaidChart.apiToken

• To find or create an API token, go to the user settings page at Mermaid Chart.

• Name the token (optional) and click on the copy button at the bottom right.

• Open the settings in IntelliJ IDEA, filter on Mermaid Chart, and paste the API token in the “API token for Mermaid Chart” field.