Wypróbuj Markdown

Ściągawka

Czym jest ściągawka Markdown?

Ściągawka Markdown to szybki przewodnik po składni, z którego możesz korzystać podczas pisania dokumentacji, plików README, notatek i treści internetowych. Zamiast zapamiętywać każdą zasadę, możesz kopiować sprawdzone wzorce dla nagłówków, list, linków, tabel i bloków kodu.

Ta strona jest zaprojektowana pod kątem szybkości: przykłady są gotowe do skopiowania i oparte na konwencjach CommonMark i oryginalnym projekcie Markdown. Świetnie współpracuje z Formatowaczem Markdown i Edytorem Markdown.

Jeśli publikujesz w portalach dokumentacji lub repozytoriach, zgodność składni jest ważna. Ta szybka informacja zawiera powszechnie używane wzorce z dokumentacji GitHub i edytorów kompatybilnych z CommonMark.

Wszystko działa w Twojej przeglądarce. Twoja treść pozostaje na Twoim urządzeniu podczas pisania i sprawdzania składni.

Jak korzystać ze ściągawki Markdown?

Wykonaj te kroki, aby przejrzeć i wypróbować składnię Markdown. Każdy krok używa rzeczywistych paneli na tej stronie.

Wklej, prześlij lub załaduj przykład

Wpisz lub wklej Markdown w lewym panelu Wypróbuj Markdown lub kliknij Prześlij, aby załadować plik. Kliknij Przykład, aby zobaczyć przykładową dokumentację API. Prawy panel Ściągawka wyświetla podstawową składnię, kod, tabele i listy zadań.

Sprawdzaj i ćwicz

Używaj ściągawki dla nagłówków, wyróżnienia, linków, bloków kodu i tabel. Kopiuj wzorce do lewego panelu, aby je wypróbować. Zgodne z CommonMark i GitHub.

Kopiuj lub pobierz

Kliknij Kopiuj lub Pobierz, aby zapisać ściągawkę. Użyj Wyczyść, aby zacząć od nowa. Wszystkie operacje odbywają się w przeglądarce.

Zaufane źródła Markdown

Autorytatywne źródła używane przez programistów, autorów technicznych i zespoły dokumentacji:

Jak korzystać z tych źródeł?

Używaj CommonMark jako podstawy, sprawdzaj zachowanie specyficzne dla platformy w dokumentacji GitHub/GitLab i weryfikuj wyrenderowany wynik przed publikacją.

Typowe przypadki użycia

Pisanie README

Korzystaj z szybkich przykładów składni podczas pisania dokumentacji projektów w repozytoriach.

Notatki techniczne

Zapewniaj spójne formatowanie dokumentów projektowych, notatek incydentów i aktualizacji architektury.

Onboarding zespołu

Nowi członkowie zespołu mogą kopiować działającą składnię zamiast uczyć się każdej zasady od zera.

Listy kontrolne

Twórz listy zadań dla wdrożeń, QA i wydań z odpowiednim formatowaniem listy kontrolnej Markdown.

Często zadawane pytania

Czy jest to oparte na standardowym Markdown?

Tak. Przewodnik podąża za powszechnie używaną składnią kompatybilną z CommonMark. Dla formalnych zasad odwiedź specyfikację CommonMark.

Czy mogę skopiować całą ściągawkę?

Tak. Użyj przycisku kopiowania, aby natychmiast skopiować cały przewodnik do schowka.

Czy mogę pobrać jako plik?

Tak. Użyj przycisku pobierania, aby zapisać ściągawkę jako plik .md.

Czy mój tekst opuszcza przeglądarkę?

Nie. Wszystko działa lokalnie w Twojej przeglądarce, podobnie jak inne narzędzia Markdown.

Czy mogę tu konwertować Markdown do HTML?

Tak. Użyj Markdown do HTML, gdy potrzebujesz konwersji. Dla semantyki HTML zapoznaj się z dokumentacją MDN HTML.

Czy mogę uporządkować niechlujny Markdown?

Tak. Użyj Formatowacza Markdown, aby naprawić odstępy i strukturę.

Inne narzędzia Markdown

Używaj tych narzędzi razem ze ściągawką w przepływach pracy pisania, formatowania i konwersji:

Ściągawka Markdown