Typemark Documentation

Diagrammid

Joonistage vookaavioid, järjestusdiagramme ja muid Mermaid-diagramme tekstist koodiploki sees.

Uuendatud 19. nov 2026

Kirjutage Mermaid diagramm koodiplokki keelega mermaid ja avaldatud lehel joonistatakse see. Diagramm elab teie lehel tekstina, seega seda saab võrrelda ja üle vaadata nagu ülejäänud dokumentatsiooni.

flowchart LR
  A[Write MDX] --> B[Push to GitHub]
  B --> C{Build passes?}
  C -->|Yes| D[Site is live]
  C -->|No| E[Previous version stays up]
```mermaid
flowchart LR
  A[Write MDX] --> B[Push to GitHub]
  B --> C{Build passes?}
  C -->|Yes| D[Site is live]
  C -->|No| E[Previous version stays up]
```

Diagrammid järgivad lugeja heledat või tumedat teemat ning joonistatakse uuesti, kui teema vahetub.

Diagrammitüübid

Töötab iga diagrammitüüp, mida Mermaid toetab, näiteks:

DiagrammEsimene rida
Vookaavioflowchart LR või graph TD
JärjestusdiagrammsequenceDiagram
KlassidiagrammclassDiagram
OlekudiagrammstateDiagram-v2
Olemi-seose diagrammerDiagram
Gantti diagrammgantt
Sektordiagrammpie
sequenceDiagram
  participant App
  participant API
  App->>API: POST /tokens
  API-->>App: 201 Created
```mermaid
sequenceDiagram
  participant App
  participant API
  App->>API: POST /tokens
  API-->>App: 201 Created
```

Vahelehtedes ja koodirühmades

Diagramm töötab kõikjal, kus töötab koodiplokk, sealhulgas vahelehtede ja koodirühmade sees. Koodirühmas nimetab silt pärast mermaid vahelehe.

<CodeGroup>
```mermaid Flow
flowchart LR
  Request --> Response
```

```bash curl
curl https://api.acme.com/health
```
</CodeGroup>

Kui diagrammis on viga

Kui Mermaid ei suuda diagrammi lugeda, kuvatakse lehel selle lähtekood koodiplokina koos lühikese märkusega vea kohta, näiteks "Parse error on line 2". Ülejäänud leht jääb puutumata. Parandage diagramm ja avaldage uuesti.

Lugejad ilma JavaScriptita ning AI-tööriistad, mis loevad teie lehte Markdownina või läbi llms.txt, saavad diagrammi lähtekoodi.

Turvalisus

Diagramme joonistatakse lugeja brauseris Mermaidi range turvatasemega: sildid ei tohi sisaldada skripte ning diagrammide klõpsutoimingud on välja lülitatud.

Visuaalses redaktoris

Mermaid-plokk jääb koodiplokiks, kuhu kirjutate, ning diagramm kuvatakse selle all. Joonis uueneb hetk pärast kirjutamise lõpetamist ning näitab viga, kui diagrammil on see. Alustamiseks lisage Koodiplokk ja valige keelevalijast Mermaid.