Podgląd Markdown
Pisz Markdown i podglądaj HTML na żywo
Szkic Markdown
Podgląd na żywo
Czym jest Podgląd Markdown?
Podgląd Markdown to narzędzie do renderowania w czasie rzeczywistym, które pokazuje dokładnie, jak kod źródłowy Markdown będzie wyglądał po konwersji do HTML. Używając interfejsu z podzielonym panelem, piszesz surowy Markdown po lewej stronie, podczas gdy prawa strona natychmiast wyświetla wyrenderowane wyjście. Ta natychmiastowa wizualna informacja zwrotna eliminuje zgadywanie przy formatowaniu Markdown — możesz zobaczyć, jak wyglądają nagłówki, czy linki działają, jak renderują się bloki kodu i czy składnia tabeli jest poprawna.
CommonMark to standardowa specyfikacja Markdown, którą śledzi większość narzędzi do podglądu, zapewniając spójne renderowanie na wszystkich platformach. To narzędzie implementuje parsowanie zgodne z CommonMark. Dla funkcji specyficznych dla GitHub, takich jak listy zadań, przekreślenie i autolinki, podgląd obsługuje również rozszerzenia GitHub Flavored Markdown.
Narzędzia do podglądu są nieocenione dla każdego twórcy treści pracującego z Markdown. Pisarze techniczni tworzący dokumentację mogą walidować złożone zagnieżdżone listy i formatowanie bloków kodu. Opiekunowie open source mogą upewnić się, że tabele funkcji renderują się poprawnie. Deweloperzy mogą odpowiednio formatować wiadomości commitów, opisy pull requestów i komentarze do issues przed wysłaniem.
Jak używać Podglądu Markdown
Wykonaj te kroki, aby podglądać Markdown jako HTML w czasie rzeczywistym.
Wklej, prześlij lub załaduj przykład
Wpisz lub wklej Markdown do lewego panelu Szkic Markdown lub kliknij Prześlij, aby załadować plik .md. Kliknij Przykład, aby zobaczyć przykładową dokumentację API. Obsługuje CommonMark i GFM (tabele, listy zadań, bloki kodu).
Wyświetl podgląd na żywo
Prawy panel Podgląd na żywo aktualizuje się podczas pisania. Zobacz wyrenderowane nagłówki, listy, tabele i bloki kodu. Brak opóźnienia — natychmiastowa informacja zwrotna.
Kopiuj lub pobierz HTML
Kliknij Kopiuj HTML lub Pobierz HTML, aby użyć wyjścia. Użyj Wyczyść, aby zacząć od nowa. Całe przetwarzanie odbywa się w przeglądarce.
Kiedy naprawdę by się przydało
Pisanie i edycja dokumentacji
Repozytoria GitHub, projekty ReadTheDocs i strony dokumentacji zbudowane z MkDocs lub Hugo — wszystkie używają Markdown. Narzędzia do podglądu pozwalają tworzyć i doskonalić dokumentację bez czekania na kompilacje lub wdrożenia.
Tworzenie issues i PR na GitHub
Pisząc szczegółowe issues lub opisy pull requestów na GitHub, narzędzia do podglądu pozwalają perfekcyjnie sformatować wiadomość. Sprawdź, czy tabele i bloki kodu są poprawne przed wysłaniem.
Tworzenie notek wydania i changelogów
Wydania oprogramowania wymagają przejrzystych, dobrze sformatowanych notek. Użyj podglądu Markdown do tworzenia changelogów z prawidłowym formatowaniem, nagłówkami wersji, listami funkcji i ostrzeżeniami o zmianach.
Często zadawane pytania (FAQ)
Czy podgląd pokazuje dokładnie, jak moja treść będzie renderowana wszędzie?
Podgląd używa parsowania zgodnego z CommonMark plus rozszerzenia GitHub Flavored Markdown, dokładnie reprezentując wygląd treści na większości nowoczesnych platform. Jednak niektóre platformy mają niestandardowe style CSS lub dodatkowe rozszerzenia. Sprawdź dokumentację platformy docelowej, jeśli potrzebujesz dokładnej zgodności wizualnej.
Jakie rozszerzenia Markdown są obsługiwane?
Ten podgląd obsługuje rdzeń składni CommonMark plus rozszerzenia GitHub Flavored Markdown: tabele, listy zadań, przekreślenie (~~tekst~~), autolinki i składnię wzmianek.
Czy mogę skopiować wygenerowany HTML?
Tak. Kliknij "Kopiuj HTML", aby skopiować wyrenderowane wyjście HTML do schowka. Następnie możesz wkleić je do dowolnego edytora HTML, klienta poczty lub formularza internetowego akceptującego HTML.
Czy znaki specjalne są prawidłowo escape'owane w wyjściu?
Tak. Parser automatycznie escape'uje specjalne znaki HTML (&, <, >, ", ') w treści tekstowej, zapobiegając atakom injection i błędom renderowania.
Jak narzędzie obsługuje podziały wierszy?
Narzędzie przestrzega reguł CommonMark: pojedynczy podział wiersza w źródle staje się spacją w wyjściu. Aby utworzyć prawdziwy podział wiersza (<br>), użyj dwóch spacji na końcu wiersza poprzedzonych nową linią lub ukośnika odwrotnego przed nową linią.
Czy mogę dołączyć surowy HTML do mojego Markdown?
Tak. Markdown pozwala na surowe bloki HTML i inline HTML. Jeśli wpiszesz HTML bezpośrednio w Markdown, zostanie on włączony do wyjścia bez zmian. Jest to przydatne do funkcji, których Markdown nie obsługuje natywnie.