## Poradnik

Dymki GitHub Markdown

Opublikowano marzec 2026

GitHub dodał składnię dymków (alertów) do GitHub Flavored Markdown. Te stylizowane ramki wyróżniają ważne informacje w dokumentacji — notatki, wskazówki, ostrzeżenia i więcej. ShowMeMyMD jest jedną z nielicznych przeglądarek desktopowych, które je renderują.

## Składnia

Pięć typów dymków

Dymki używają składni cytatów blokowych ze specjalnym znacznikiem w pierwszej linii. Format jest zawsze taki sam: > [!TYPE] a następnie treść w kolejnej linii, również z prefiksem >.

> [!NOTE]
> Useful information that users should know,
> even when skimming content.

NOTE — Renderuje się jako niebieska ramka informacyjna. Używaj do dodatkowego kontekstu, który jest pomocny, ale nie krytyczny. Informacje typu 'nawiasem mówiąc'.

> [!TIP]
> Helpful advice for doing things better
> or more easily.

TIP — Renderuje się jako zielona ramka sugestii. Używaj do najlepszych praktyk, skrótów lub rekomendacji ułatwiających życie czytelnikowi.

> [!IMPORTANT]
> Key information users need to know to
> achieve their goal.

IMPORTANT — Renderuje się jako fioletowa ramka podkreślenia. Używaj do informacji kluczowych do zrozumienia przed kontynuowaniem. Nie ostrzeżenie, ale coś, czego nie można pominąć.

> [!WARNING]
> Urgent info that needs immediate user
> attention to avoid problems.

WARNING — Renderuje się jako żółta ramka alertu. Używaj do potencjalnych problemów, pułapek lub rzeczy, które mogą pójść źle, jeśli czytelnik nie będzie uważny.

> [!CAUTION]
> Advises about risks or negative outcomes
> of certain actions.

CAUTION — Renderuje się jako czerwona ramka niebezpieczeństwa. Rezerwuj dla operacji nieodwracalnych, scenariuszy utraty danych lub działań, które mogą coś zepsuć.

## Wskazówki użycia

Pisanie skutecznych dymków

Używaj ich oszczędnie

Zbyt wiele dymków tworzy szum wizualny. Jeśli wszystko jest ważne, nic nie jest. Strona pełna kolorowych ramek uczy czytelników je ignorować. Jeden lub dwa na sekcję to zwykle odpowiednia ilość.

Dopasuj typ do powagi

Nie używaj CAUTION do drobnej wskazówki. Nie używaj NOTE do czegoś, co może usunąć bazę danych. Kolorowe kodowanie istnieje, żeby dać czytelnikom natychmiastowy sygnał o wadze — szanuj to.

Zachowaj zwięzłość

Dymki najlepiej działają z jednym do trzech zdań. Jeśli potrzebujesz wielu akapitów, informacja prawdopodobnie należy do głównego tekstu, a nie do ramki dymka.

Możesz zagnieżdżać inne elementy

Fragmenty kodu, linki, pogrubienie i kursywa działają wewnątrz dymków. Poprzedzaj każdą linię >, żeby utrzymać treść wewnątrz bloku dymka.

## Kompatybilność

Gdzie dymki się renderują

Narzędzie	Obsługa dymków
GitHub (web)	Pełna — kolorowe ramki z ikonami
ShowMeMyMD	Pełna — stylizowane dymki na desktopie
Niektóre rozszerzenia VS Code	Zależy od rozszerzenia
Większość innych przeglądarek Markdown	Nie — pokazuje zwykły cytat blokowy
Standardowe renderery CommonMark	Nie — zwykły cytat blokowy
Starsze parsery GFM	Nie — zwykły cytat blokowy

Większość przeglądarek Markdown pokazuje tylko cytat blokowy.

ShowMeMyMD renderuje pełny stylizowany dymek — kolorowy pasek boczny, ikonę i prawidłowe formatowanie — tak jak wygląda na GitHub. Jeśli piszesz README lub dokumentację z dymkami, to jeden z nielicznych sposobów na podgląd ich lokalnie na Macu.

## Czytaj dalej

Dowiedz się więcej o ShowMeMyMD jako przeglądarce Markdown na Maca. Zobacz, dlaczego programiści wybierają go jako swoją przeglądarkę Markdown dla programistów. Lub dodaj do zakładek naszą ściągawkę Markdown.

Podglądaj dymki lokalnie

Przestań pushować na GitHub tylko po to, żeby sprawdzić, jak wyglądają Twoje dymki. ShowMeMyMD renderuje NOTE, TIP, IMPORTANT, WARNING i CAUTION — bezpośrednio na Twoim Macu. $2.99 w Mac App Store.