Jamdesk Documentation logo

Diagramas Mermaid

Renderize fluxogramas, diagramas de sequência, linhas do tempo, gráficos de pizza e mais a partir de sintaxe Mermaid em texto. Os diagramas são gerados como SVG no momento do build.

Escreva diagramas como texto em blocos de código delimitados. A Jamdesk os renderiza como SVG no momento do build.

Rascunhe e visualize seu diagrama no editor Mermaid da Jamdesk. É um editor de código aberto que roda no navegador e renderiza enquanto você digita. Cole o resultado em um bloco cercado por mermaid.

A Jamdesk também renderiza diagramas D2 em blocos cercados por d2. Use D2 quando um diagrama precisar de contêineres aninhados, um esquema SQL com chaves primárias e estrangeiras, ou quando quiser trocar o mecanismo de layout. Os exemplos Mermaid desta página têm equivalentes em D2 na página do D2.

Uso básico

Use um bloco de código delimitado com o identificador de linguagem mermaid:

```mermaid
flowchart LR
    A[Start] --> B[Process] --> C[End]
```

Tipos de diagramas

Fluxogramas

A direção pode ser de cima para baixo (TD), da esquerda para a direita (LR), de baixo para cima (BT) ou da direita para a esquerda (RL).

```mermaid
flowchart TD
    A[User Request] --> B{Valid?}
    B -->|Yes| C[Process]
    B -->|No| D[Error]
    C --> E[Response]
    D --> E
```

Subgrafos

Agrupe nós relacionados com subgrafos. Use-os para dividir um fluxograma grande em seções como "Frontend" e "Backend", ou em etapas de um pipeline.

```mermaid
flowchart TB
    subgraph Frontend
        A[React App] --> B[Components]
    end
    subgraph Backend
        C[API Server] --> D[(Database)]
    end
    B -->|HTTP| C
```

Diagramas de sequência

Diagramas de sequência mostram como os componentes interagem ao longo do tempo. Use um diagrama de sequência para fluxos de chamadas de API e handshakes de autenticação. Os participantes aparecem como linhas de vida verticais. As mensagens circulam entre eles.

```mermaid
sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: Request
    Server->>Database: Query
    Database-->>Server: Results
    Server-->>Client: Response
```

Diagramas de classes

Diagramas de classe mostram a estrutura de sistemas orientados a objetos, como um modelo de dados ou os tipos centrais de um serviço. Eles exibem classes com seus atributos, métodos e relacionamentos.

```mermaid
classDiagram
    class User {
        +String name
        +String email
        +login()
        +logout()
    }
    class Order {
        +int id
        +Date created
        +addItem()
        +checkout()
    }
    class Item {
        +String name
        +float price
    }
    User "1" --> "*" Order : places
    Order "1" --> "*" Item : contains
```

Diagramas de estado

Diagramas de estado modelam o ciclo de vida de um objeto ou processo. Eles mostram cada estado e as transições entre eles. Status de pedidos e fluxos de aprovação de documentos são exemplos típicos.

```mermaid
stateDiagram-v2
    [*] --> Draft
    Draft --> Review
    Review --> Published
    Review --> Draft
    Published --> [*]
```

Diagramas de entidade-relacionamento

Diagramas ER documentam esquemas de banco de dados e modelos de dados. Eles mostram entidades (tabelas), seus atributos (colunas) e os relacionamentos entre elas. Os símbolos indicam a cardinalidade: um para um, um para muitos ou muitos para muitos.

```mermaid
erDiagram
    USER ||--o{ ORDER : places
    ORDER ||--|{ ITEM : contains
    USER {
        string name
        string email
    }
    ORDER {
        int id
        date created
    }
```

Gráficos de Gantt

Gráficos de Gantt mostram cronogramas de projetos. As tarefas aparecem como barras horizontais em uma linha do tempo, com duração, dependências e trabalho paralelo. Use um para um plano de projeto ou roadmap.

```mermaid
gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Planning
        Research       :a1, 2024-01-01, 7d
        Design         :a2, after a1, 5d
    section Development
        Backend        :b1, after a2, 14d
        Frontend       :b2, after a2, 14d
    section Launch
        Testing        :c1, after b1, 7d
        Deployment     :c2, after c1, 2d
```

Gráficos do Git

Grafos Git mostram estratégias de branching e fluxos de controle de versão: commits, branches, merges e histórico do repositório. Cada branch recebe sua própria cor.

```mermaid
gitGraph
    commit id: "Initial"
    branch feature
    checkout feature
    commit id: "Add login"
    commit id: "Add auth"
    checkout main
    merge feature id: "v1.0"
    branch release
    checkout release
    commit id: "Prep 1.1"
    checkout main
    branch hotfix
    checkout hotfix
    commit id: "Fix bug"
    checkout main
    merge hotfix id: "v1.0.1"
    checkout release
    commit id: "Final QA"
    checkout main
    merge release id: "v1.1"
```

Diagramas de linha do tempo

Linhas do tempo mostram eventos ao longo de períodos. Comece com a palavra-chave timeline, um title opcional e depois uma linha por período, com os eventos separados por dois-pontos:

```mermaid
timeline
    title Product Launch Timeline
    2024 : Research
         : First prototype
    2025 : Private beta
         : Public beta
    2026 : GA launch
```

Gráficos de pizza

Gráficos de pizza mostram proporções como fatias de um círculo. Use um quando as partes compõem um todo, como participação de mercado ou resultados de pesquisa. Limite-se a 6 fatias ou menos.

```mermaid
pie title Browser Market Share
    "Chrome" : 65
    "Safari" : 19
    "Firefox" : 10
    "Edge" : 4
    "Other" : 2
```

Formas de fluxogramas

Cada forma tem um significado convencional em fluxogramas:

SintaxeFormaUse para
[text]RetânguloEtapas de processo, ações
(text)Retângulo arredondadoPontos de início/fim
{text}LosangoDecisões, condições
([text])Estádio (cápsula)Eventos, gatilhos
[[text]]Sub-rotinaProcessos predefinidos
[(text)]CilindroBancos de dados, armazenamento

Tipos de setas

As setas indicam direção do fluxo e tipos de relacionamento:

SintaxeDescriçãoUse para
-->Seta sólidaFluxo normal
---Linha sólidaAssociações
-.->Seta pontilhadaFluxo opcional ou assíncrono
==>Seta grossaCaminhos importantes
--text-->Seta com rótuloDescreva a transição

Ajustar o tamanho de diagramas largos

Use o componente Mermaid com a prop minWidth para evitar que um diagrama largo, como um gráfico de Gantt ou um grafo Git grande, seja comprimido:

<Mermaid minWidth="700px">
gantt
    title Wide Project Timeline
    ...
</Mermaid>

Clique para ampliar

Clique em um diagrama para abri-lo em tela cheia em telas de 768px ou mais. Com o teclado, foque o diagrama e pressione Enter. Feche com Escape, com o botão de fechar ou clicando fora do diagrama.

Desative isso em um diagrama específico com a forma de componente e noZoom:

<Mermaid data-no-zoom="true">
graph LR
    A[Request] --> B[Response]
</Mermaid>

Diagramas escritos como blocos ```mermaid sempre abrem em tela cheia.

Dicas de estilo

Os diagramas Mermaid mudam para o modo escuro junto com o site.

  • Divida um fluxo grande em diagramas menores.
  • Rotule suas setas para explicar as transições.
  • Escolha uma direção: TD (de cima para baixo) para diagramas altos, LR (da esquerda para a direita) para os largos.
  • Limite cada diagrama a 10-15 nós.

Para colorir um nó, use style para um nó ou classDef para um grupo:

A Jamdesk mantém suas cores no modo escuro. Um preenchimento sem cor de texto recebe uma cor de rótulo que a Jamdesk escolhe para ser legível sobre o preenchimento.

Saiba mais

Consulte a documentação oficial do Mermaid para a sintaxe completa, incluindo estilização, temas e mais tipos de diagrama.

Próximos passos

Diagramas D2

Arquitetura, contêineres e esquemas SQL com D2

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes em MDX