Skip to content
ArchTect Docs

Mermaid Export

Export your architecture views as Mermaid diagram code — a text-based diagramming syntax supported by GitHub, GitLab, Notion, and many Markdown renderers.

Why Mermaid

Section titled “Why Mermaid”
  • Embeds in Markdown — Paste directly into GitHub READMEs, pull request descriptions, wikis, and Markdown documentation.
  • Renders automatically — GitHub, GitLab, Notion, and other platforms render Mermaid blocks into diagrams without any plugin.
  • Version-control friendly — Text-based output diffs cleanly in git.

How to export

Section titled “How to export”
  1. Open the view you want to export.
  2. Click Export → Mermaid in the toolbar.
  3. The Mermaid code is generated and available for download or copy.

Example output

Section titled “Example output”

A system context view might export as:

```mermaid
graph TB
  User["User<br/><i>A user of the system</i>"]
  System["My System<br/><i>The system being modeled</i>"]
  User -->|"Uses"| System
```

Usage

Section titled “Usage”

Paste the output into any Markdown file:

## Architecture


```mermaid
graph TB
  User["User"]
  System["My System"]
  User -->|"Uses"| System
```

The diagram renders automatically in GitHub, GitLab, Azure DevOps, Notion, and other Mermaid-compatible platforms.

See also

Section titled “See also”