Skip to main content
CheckTown
Dev Tools

Podgląd Markdown: Pisz i renderuj Markdown w czasie rzeczywistym

Opublikowano 5 min czytania
W tym artykule

Czym jest Markdown?

Markdown to lekki język znaczników stworzony przez Johna Grubera w 2004 roku. Używa prostej składni opartej na znakach interpunkcyjnych do formatowania zwykłego tekstu — nagłówki z #, pogrubienie z **, linki jako [tekst](url) — który renderuje się do sformatowanego HTML. Dzięki prostocie stał się powszechnym standardem dokumentacji dla programistów.

Markdown jest wszechobecny: pliki README na GitHub, odpowiedzi na Stack Overflow, wiadomości w Slack, strony w Notion, serwisy dokumentacyjne i platformy blogowe. Większość programistów pisze Markdown codziennie, nie zastanawiając się nad tym.

Jak działa podgląd Markdown

Podgląd Markdown w CheckTown renderuje Markdown do HTML w czasie rzeczywistym podczas pisania.

  • Zgodność z CommonMark — renderuje standardowy Markdown zgodnie ze specyfikacją CommonMark
  • Rozszerzenia GFM — obsługuje GitHub Flavored Markdown, w tym tabele, listy zadań i przekreślenie tekstu
  • Podświetlanie składni — bloki kodu są podświetlane dla popularnych języków programowania

Wypróbuj za darmo — bez rejestracji

Podgląd Markdown →

Kiedy używać podglądu Markdown

Podgląd Markdown jest przydatny w każdym procesie pisania, gdzie trzeba sprawdzić renderowanie przed publikacją.

  • Pliki README — pisz i przeglądaj pliki README.md przed wysłaniem na GitHub
  • Dokumentacja — pisz i przeglądaj dokumentację techniczną przed opublikowaniem w serwisach dokumentacyjnych
  • Wpisy blogowe — twórz wpisy blogowe w Markdown i przeglądaj sformatowane wyjście

Często zadawane pytania

Jaka jest różnica między dialektami Markdown?

Oryginalna specyfikacja Markdown pozostawiała wiele przypadków brzegowych niezdefiniowanych, co doprowadziło do wielu niekompatybilnych implementacji. CommonMark to ustandaryzowana specyfikacja, która rozwiązuje niejednoznaczności. GitHub Flavored Markdown (GFM) rozszerza CommonMark o tabele, listy zadań i autolinki. Większość platform używa CommonMark lub GFM.

Czy Markdown może zawierać surowy HTML?

Tak, większość procesorów Markdown pozwala na osadzanie surowych znaczników HTML bezpośrednio w dokumentach Markdown. Jest to przydatne do zaawansowanego formatowania nieobsługiwanego przez składnię Markdown. Jednak wiele platform sanityzuje HTML ze względów bezpieczeństwa, więc surowy HTML może być usuwany w kontekście treści generowanych przez użytkowników.

Jak dodać tabelę w Markdown?

Tabele używają znaków pipe i myślników: | Nagłówek 1 | Nagłówek 2 | w pierwszym wierszu, | --- | --- | w drugim wierszu jako separator, a następnie wiersze danych. Wyrównanie kolumn jest kontrolowane przez pozycję dwukropka w separatorze: :--- dla lewej, :---: dla środka, ---: dla prawej.

Powiązane narzędzia