Astah Mermaid Plugin

What is Mermaid?

Mermaid is a JavaScript-based diagramming tool that generates diagrams from Markdown-style text. Because diagrams are stored as text, they are easy to share, edit, and manage in Git, especially on GitHub.

What you can do with this plugin

With the Astah Mermaid Plugin, you can:

• Export Astah diagrams to Mermaid code: Paste the generated text into GitHub, the Mermaid editor, and other tools that support Mermaid.
• Keep diagrams under version control: Because Mermaid diagrams are text, you can track changes clearly in Git.

How to Install

1. Download the Plug-in .jar file.
2. Drag and drop the .jar file onto an open instance of Astah. When prompted, click [Yes] to confirm the installation.
3. Restart Astah to activate the plug-in.
4. If you see [Mermaid plugin] under [Tools], the installation is complete.
   

How to Use

Export multiple diagrams at once

1. Open a project file.
2. Go to [Tools] – [Mermaid plugin] – [Save as Mermaid format].
3. Choose a destination folder.
4. Mermaid files for all class diagrams and sequence diagrams in the project are exported to the folder.

Export a single diagram

1. Open the class diagram or sequence diagram you want to export.
2. Go to [Tools] – [Mermaid plugin] – [Copy this diagram to clipboard]. You can now paste the Mermaid code wherever you need it.

Supported model elements

Class diagram

• Classes
• Associations / Dependencies / Realizations / Usages / Generalizations
• Attributes / Operations
• Parameters / Return values
• Stereotypes

Sequence diagram

• Lifelines
• Messages

※To export flowcharts to Mermaid, you can use this script with the Script Editor.

Acknowledgments

Many thanks to Avens666 for the inspiration.