W Mermaid kilka wierszy tekstu zamienia się w diagram. Markdown Preview Editor działa jako edytor Mermaid z podglądem na żywo: wpisujesz kod diagramu w dokumencie Markdown, a podgląd rysuje go w trakcie pisania. W przeciwieństwie do osobnego programu do diagramów rysunek jest częścią tekstu wokół niego, więc dokument projektowy, README czy konspekt lekcji mieści się w jednym pliku.
Czym jest diagram Mermaid?
Diagram Mermaid to wykres opisany zwykłym tekstem. Nie przeciągasz prostokątów i strzałek — piszesz wiersze w rodzaju A --> B, a Mermaid sam rozmieszcza elementy. Obsługuje schematy blokowe, diagramy sekwencji, wykresy Gantta, diagramy stanów i klas, wykresy kołowe, mapy myśli i więcej.
Ponieważ diagram jest tekstem, łatwo go zmienić, trzymać w systemie kontroli wersji i przeglądać w diffach. GitHub, GitLab, Obsidian i wiele narzędzi do dokumentacji renderuje Mermaid, więc ten sam kod działa we wszystkich.
Jak narysować diagram
- Otwórz edytor. Przejdź do edytora online.
- Dodaj blok Mermaid. Wpisz trzy grawisy (backticki), a po nich
mermaid, albo wstaw szablon przyciskiem Diagram Mermaid w rzędzie narzędzi Edytor zaawansowany. - Napisz diagram. Podgląd po prawej przerysowuje go w trakcie pisania, więc brakującą strzałkę czy nawias widać od razu.
- Zapisz lub udostępnij. Zapisz dokument jako
.md, wyeksportuj go do HTML albo wydrukuj do PDF — diagramy są w nim uwzględnione.
Oto pierwszy schemat blokowy:
markdown```mermaid
flowchart LR
A[Pomysł] --> B{Warto?}
B -- tak --> C[Zrób to]
B -- nie --> D[Odłóż]
```
Dostępne typy diagramów
| Typ | Zaczyna się od | Do czego się nadaje |
|---|---|---|
| Schemat blokowy | flowchart TD / flowchart LR |
Procesy, decyzje, algorytmy |
| Diagram sekwencji | sequenceDiagram |
API, logowanie, ścieżki użytkownika |
| Wykres Gantta | gantt |
Plany projektów i harmonogramy |
| Diagram stanów | stateDiagram-v2 |
Statusy zamówienia lub dokumentu |
| Diagram klas | classDiagram |
Modele danych i struktura kodu |
| Wykres kołowy | pie |
Udziały w całości |
Pełną składnię każdego typu wraz z przykładami gotowymi do skopiowania znajdziesz w poradniku o diagramach Mermaid w Markdown.
Dlaczego warto
- Podgląd na żywo. Diagram aktualizuje się podczas pisania; błędy składni widać od razu.
- Tekst i diagramy razem. Objaśnienia, wzory i schemat blokowy piszesz w jednym pliku Markdown.
- Prywatnie. Diagramy są rysowane w Twojej przeglądarce. Kod nie jest wysyłany na serwer.
- Za darmo i open source. Bez konta i bez limitu liczby diagramów.
Ograniczenia
- Nie ma osobnego pobierania pojedynczego diagramu jako PNG lub SVG. Diagramy są eksportowane jako część dokumentu — w eksporcie HTML i w PDF. Osobny obraz można wyeksportować oficjalnymi narzędziami Mermaid.
- Własne motywy i style poszczególnych węzłów są ograniczone: diagramy mają prosty, domyślny wygląd dopasowany do jasnego lub ciemnego motywu.
- Diagramy pisze się jako kod; nie ma wizualnej edycji metodą przeciągnij i upuść.
Chcesz tylko obejrzeć istniejący plik Markdown z diagramami? Użyj przeglądarki Markdown albo wróć na stronę główną edytora Markdown.
Najczęściej zadawane pytania
Czy ten edytor Mermaid jest darmowy?
Tak. Jest darmowy i open source, bez rejestracji i bez limitów.
Jakie typy diagramów Mermaid są obsługiwane?
Schematy blokowe, diagramy sekwencji, wykresy Gantta, diagramy stanów, klas i związków encji, wykresy kołowe, mapy myśli, osie czasu i pozostałe typy obsługiwane przez Mermaid.
Czy mogę wyeksportować diagram Mermaid?
Diagramy są dołączane, gdy eksportujesz dokument do HTML albo drukujesz go do PDF. Osobne pobieranie jednego diagramu jako PNG lub SVG nie jest dostępne.
Dlaczego mój diagram Mermaid się nie wyświetla?
Najczęściej to błąd składni: brakująca strzałka, niezamknięty nawias albo znaki specjalne w etykiecie bez cudzysłowu. Pierwszy wiersz musi określać typ diagramu, na przykład flowchart TD.
Czy edytor wysyła gdzieś kod mojego diagramu?
Nie. Diagram jest rysowany w Twojej przeglądarce, a dokument zostaje na Twoim urządzeniu.
