Markdown Preview
Live Markdown preview
Live Markdown preview Działa lokalnie w Twojej przeglądarce
About the
Podgląd Markdown renderuje Markdown podczas pisania, w widoku obok siebie, zgodnie z CommonMark z rozszerzeniami GitHub, z których korzysta większość ludzi: tabele, listy zadań, chronione bloki kodu, przekreślenia i automatyczne łącza. Jest to najszybszy sposób sprawdzenia pliku README przed jego zatwierdzeniem, ponieważ różnice między tym, jak Markdown wygląda w źródle, a tym, jak wygląda po renderowaniu, nie są oczywiste, a zwłaszcza składnia tabeli zawodzi po cichu, gdy pojedyncza kreska lub myślnik jest błędny. Wyrenderowany kod HTML można również skopiować, jeśli jest potrzebny w miejscu, które nie przetwarza samego Markdown.
Where people use the
- Sprawdzenie, czy plik README renderuje się poprawnie przed jego wypchnięciem.
- Sporządzanie notatek o wydaniu lub dziennika zmian z podglądem wyników na żywo.
- Konwersja dokumentu Markdown na HTML dla CMS-a, który nie akceptuje Markdown.
- Przeglądanie żądania ściągnięcia Markdown innej osoby i sprawdzanie, jak będzie wyglądać.
How to use the
- 1
Wklej lub napisz swój Markdown
Edytor akceptuje wszystko, od pojedynczego akapitu po pełny dokument z nagłówkami, listami, linkami i ograniczeniami kodu.
- 2
Obejrzyj wyrenderowany panel
Podgląd jest aktualizowany po każdym naciśnięciu klawisza, więc uszkodzony stół lub niezamknięty płot pojawiają się natychmiast, a nie po etapie publikowania.
- 3
Napraw źródło, a nie podgląd
Podgląd jest tylko do odczytu. Kiedy coś jest renderowane nieprawidłowo, przyczyną prawie zawsze jest brakujący pusty wiersz przed listą lub nagłówek tabeli bez wiersza rozdzielającego.
- 4
Skopiuj kod HTML, jeśli go potrzebujesz
Przejdź do widoku HTML, aby pobrać wygenerowany znacznik, który jest przydatny do wklejenia do systemu CMS, który oczekuje HTML, a nie Markdown.
Wskazówki i najlepsze praktyki
- Pozostaw pustą linię przed i po każdym elemencie bloku; Najbardziej tajemniczymi błędami renderowania są brakująca pusta linia.
- Używaj chronionych bloków kodu z nazwą języka, aby kod był podświetlony, a nie traktowany jako zwykły tekst.
- W długich dokumentach należy zachować jedno zdanie w każdym wierszu; dzięki temu różnice będą czytelne później.
Często zadawane pytania
Która specyfikacja Markdown jest używana?
CommonMark jako podstawa oraz rozszerzenia GitHub Flavoured Markdown dla tabel, list zadań, kodu chronionego i przekreślenia. Ta kombinacja obejmuje format README w GitHub, GitLab i większości witryn z dokumentacją.
Dlaczego moja tabela się nie renderuje?
Tabela wymaga wiersza nagłówka, po którym bezpośrednio następuje rząd myślników rozdzielających, a przed blokiem powinna znajdować się pusta linia. Każdy wiersz musi mieć taką samą liczbę rurek jak nagłówek. Każdy z tych brakujących zamienia całość w akapit tekstu zawierający znaki potokowe.
Dlaczego moje elementy listy zostały połączone w jeden akapit?
Markdown potrzebuje pustej linii pomiędzy akapitem a listą, która po nim następuje. Bez tego znaczniki listy są traktowane jak zwykły tekst.
Czy obsługuje LaTeX lub matematykę?
Nie. Renderowanie matematyki wymaga osobnej biblioteki, takiej jak KaTeX lub MathJax, i innej składni. Wyrażenie zawierające znak dolara będzie wyświetlane jako zwykły tekst.
Czy surowy HTML jest dozwolony?
Tak, wbudowany kod HTML przechodzi bezpośrednio, co również robi GitHub. Jeśli publikujesz wyniki w dowolnym miejscu publicznym, najpierw je oczyść, ponieważ surowy kod HTML służy również do wstrzykiwania skryptów.
Gdzie trafia mój tekst?
Nigdzie. Analizowanie i renderowanie odbywa się w przeglądarce za pomocą biblioteki JavaScript Markdown. Nic nie jest zapisywane ani przesyłane, więc wersja robocza zniknie po zamknięciu karty, chyba że ją skopiujesz.