Wypróbuj Markdown

Ściągawka

Czym jest ściągawka Markdown?

Markdown to format zwykłego tekstu dla dokumentów strukturalnych. Ściągawka to szybkie odniesienie do składni: nagłówki, listy, linki, tabele, bloki kodu i inne. Specyfikacja CommonMark i GitHub Flavored Markdown (GFM) definiują składnię używaną w plikach README, dokumentacji i wiki.

To narzędzie wyświetla gotową do użycia ściągawkę w prawym panelu. Użyj lewego edytora, aby wypróbować składnię i zobaczyć, jak jest renderowana. Skopiuj lub pobierz ściągawkę do użytku offline. Aby generować tabele z CSV, użyj Generatora Tabeli Markdown.

Jak używać tego narzędzia

1

Przeglądaj ściągawkę

Prawy panel pokazuje nagłówki, wyróżnienia, listy, linki, obrazy, cytaty, kod, tabele, listy zadań i poziome linie. Każdy przykład używa standardowej składni CommonMark i GFM.

2

Wypróbuj Markdown w edytorze

Wklej lub wpisz Markdown w lewym edytorze. Użyj Przykładu, aby załadować przykładową treść. Eksperymentuj z pogrubieniem, kursywą, listami i tabelami. Aby sformatować istniejący Markdown, użyj Formatera Markdown.

3

Kopiuj lub pobierz

Skopiuj ściągawkę do schowka lub pobierz ją jako plik .md. Aby przekonwertować Markdown do HTML, użyj Markdown do HTML. Aby wygenerować spis treści z nagłówków, użyj Generatora TOC Markdown.

Szybki przewodnik

Podstawowa składnia Markdown

Markdown:

# Heading 1
## Heading 2

**bold** and *italic* and `code`

- List item 1
- List item 2

[Link text](https://example.com)

> Blockquote

Wyświetlane jako:

Large heading
Medium heading

Bold text, italic text, and inline code

Bulleted list with two items

Clickable hyperlink

Indented block quote

Kiedy ściągawka jest przydatna

Nowi użytkownicy Markdown potrzebują szybkiego odniesienia. Markdown Guide i dokumentacja GitHub dostarczają samouczków; ściągawka uzupełnia je przykładami do kopiowania. Tabele, listy zadań i ogrodzonych bloków kodu są powszechne w plikach README i dokumentacji.

Aby sprawdzić styl Markdown, użyj Lintera Markdown. Aby walidować składnię, użyj Walidatora Markdown. Aby przekonwertować HTML na Markdown, użyj HTML do Markdown.

Często zadawane pytania

Jaka jest różnica między Markdown a HTML?

Markdown to lekki język znaczników, który konwertuje się do HTML. Zamiast pisać <strong>pogrubienie</strong> piszesz **pogrubienie**. Markdown jest szybszy do pisania i łatwiejszy do czytania jako zwykły tekst. Jest szeroko stosowany w dokumentacji, plikach README i tworzeniu treści.

Czy Markdown jest taki sam wszędzie?

Nie do końca. Oryginalna specyfikacja Markdown pozostawia pewne niejasności, więc różne platformy implementują lekkie warianty. CommonMark to znormalizowana specyfikacja, której przestrzega większość narzędzi. GitHub Flavored Markdown (GFM) dodaje funkcje takie jak listy zadań i tabele.

Jak dodać podział wiersza w Markdown?

Zakończ wiersz dwoma lub więcej spacjami przed naciśnięciem Enter, lub użyj ukośnika wstecznego \ na końcu wiersza. Niektóre parsery traktują też pustą linię między akapitami jako podział. Zachowanie różni się nieznacznie między wariantami Markdown.

Czy mogę używać HTML wewnątrz Markdown?

Tak — większość parserów Markdown pozwala na surowy HTML inline. Możesz używać <br>, <div>, <span> i większości innych tagów HTML bezpośrednio w plikach Markdown. Przydatne do wyśrodkowania treści lub dodawania niestandardowych stylów.

Czy moje dane są prywatne?

Tak. Wszystko działa w przeglądarce. Żadna treść nie jest wysyłana na żaden serwer.

Powiązane narzędzia

Dowiedz się więcej: CommonMark, specyfikacja CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub.