Wejście Markdown

Sformatowany Markdown

Przykłady formatowania Markdown

Zminifikowany lub chaotyczny Markdown jest trudny do czytania; formatowanie dodaje wcięcia i podziały wierszy. Przykład:

Dokumentacja API

Wejście zminifikowane:

Wejście

Wyjście sformatowane:

Wyjście

Kliknij Przykład powyżej, aby załadować więcej danych przykładowych.

Czym jest Formater Markdown?

Markdown to lekki język znaczników do pisania dokumentacji, plików README i treści internetowych. Niespójne odstępy, mieszane podziały wierszy lub chaotyczne listy sprawiają, że Markdown jest trudny do czytania. Formater Markdown normalizuje wcięcia, odstępy list i strukturę, aby dokument był czysty i spójny. Specyfikacja CommonMark definiuje składnię.

To narzędzie parsuje Markdown i reformatuje go. Działa w całości w przeglądarce. Nic nie jest wysyłane na serwer. Do konwersji na HTML użyj Markdown do HTML. Do walidacji użyj Walidatora Markdown.

Jak używać tego narzędzia

1

Wklej lub wczytaj

Skopiuj swój Markdown i wklej go do lewego edytora. Możesz też kliknąć Wczytaj, aby załadować plik .md lub .markdown. Przycisk Przykład ładuje dane przykładowe.

2

Sprawdź wyjście

Prawy panel pokazuje sformatowany Markdown. Nagłówki, listy, bloki kodu i linki są normalizowane. Nieprawidłowa lub niejednoznaczna składnia może być zachowana tak jak jest.

3

Skopiuj lub pobierz

Użyj Kopiuj lub Pobierz. Do podglądu na żywo użyj Edytora Markdown. Do generowania spisu treści użyj Generatora TOC Markdown.

Kiedy formatowanie Markdown jest przydatne

Przy edycji plików README na GitHub, dokumentacji na GitHub Docs lub treści od wielu autorów, formatowanie normalizuje styl. Niespójne wcięcia list lub mieszane style nagłówków utrudniają utrzymanie dokumentów. Przepuszczenie Markdown przez to narzędzie daje czystą bazę. Patrz podstawowa składnia Markdown jako odniesienie.

Treści z eksportów CMS, tekst skopiowany z internetu lub Markdown generowany przez AI często mają chaotyczne odstępy. Formatowanie ich tutaj poprawia czytelność przed commitowaniem lub publikowaniem. Do podglądu składni użyj Ściągawki Markdown.

Często zadawane pytania

Czy moje dane są prywatne?

Tak. Formatowanie działa w całości w przeglądarce. Żadne dane nie są wysyłane na żaden serwer.

Czy obsługuje GitHub Flavored Markdown?

Formater obsługuje popularny Markdown. Rozszerzenia GFM (tabele, przekreślony tekst, listy zadań) są zazwyczaj zachowywane. Dla pełnego GFM sprawdź wyjście.

Co z blokami kodu?

Ogrodzone bloki kodu (potrójne backticki) i bloki kodu z wcięciami są zachowywane. Identyfikatory języka są utrzymywane. Formatowanie skupia się na strukturze, nie na zawartości kodu.

Czy mogę przekonwertować na HTML?

Tak. Użyj Markdown do HTML, aby przekonwertować sformatowane wyjście. HTML odzwierciedli oczyszczoną strukturę.

Czy zmienia znaczenie?

Formatowanie ma na celu zachowanie semantyki. Białe znaki i struktura są normalizowane. Przypadki graniczne (np. niejednoznaczne listy) mogą być renderowane inaczej — podejrzyj przed publikowaniem.

Powiązane narzędzia

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