Co wyrzuca narzędzie usuwające Markdown i jak to zachować

„Usuń Markdown” brzmi jak jedna operacja. W rzeczywistości to seria małych decyzji, a konwerter podejmuje każdą z nich za ciebie, niezależnie od tego, czy się do tego przyznaje.

Oto co zwykle bywa rozstrzygnięte źle.

Numeracja list

Najważniejsza. Popularne biblioteki traktują listę jako konstrukcję formatującą i spłaszczają ją, co usuwa 1. 2. 3. wraz ze znakami wypunktowania.

Dla listy wypunktowanej można się z tym spierać. Dla numerowanej niszczy to sens: numery do czegoś się odnosiły. Odpowiedzi na numerowaną ankietę, kroki w kolejności, elementy ułożone w ranking — wszystko zamienia się w nieuporządkowany stos.

Numeracja jest tutaj zachowywana, także w listach zaczynających się od 7 i w liście numerowanej zagnieżdżonej w innej.

Adres kryjący się za linkiem

[dokumentacja](https://example.com/przewodnik) zawiera dwie informacje. Zwykły tekst nie ma gdzie umieścić drugiej, więc konwerter musi ją albo wypisać, albo porzucić.

Porzucenie odbywa się bez słowa i jest częste. Czytelnik dostaje „dokumentacja” i żadnej drogi, żeby do niej dotrzeć. Wartość domyślna wypisuje tutaj obie — dokumentacja (https://example.com/przewodnik) — bo czytelnik, który nie może pójść za linkiem, coś stracił. Tylko tekst i tylko adres są dostępne, gdy wiesz, że link nie ma znaczenia.

Język bloku kodu

Blok oznaczony ```java niesie fakt: to jest Java. Usuń oznaczenie i ten fakt odchodzi razem z nim, pozostawiając blok niewyjaśnionych symboli, który mógłby być czymkolwiek.

Język jest podawany jako etykieta — [java] — żeby czytelnik wiedział. Wyłączone albo zachowane jako pierwotne oznaczenie, jeśli wolisz.

Tekst alternatywny obrazu

Obraz nie może przetrwać jako obraz. Ale jego tekst alternatywny to zdanie, które ktoś napisał, żeby go opisać, i często jest to jedyny opis tej treści w dokumencie. Odrzucenie obrazu i zachowanie opisu jest zwykle lepsze niż odrzucenie obu.

Przypisy, cytaty, separatory, frontmatter

Każde z nich to treść, którą narzędzie usuwające może po cichu wyrzucić. Każde jest tutaj domyślnie zachowywane i można je wyłączyć osobno.

Dlaczego bezstratność to właściwa wartość domyślna

Sprawdzian, który rozstrzyga większość tych przypadków: czy czytelnik, który nigdy nie widział wejścia, zrozumiałby wszystko, co ono mówiło, wyłącznie z wyniku?

Jeśli odpowiedź brzmi nie, konwerter wyrzucił informację w imieniu czytelnika, nie pytając. Konwerter, który zostawia coś, co musisz usunąć sam, jest irytujący przez dziesięć sekund. Taki, który usuwa coś, czego potrzebowałeś, to problem, którego możesz nie zauważyć, dopóki nie zacznie mieć znaczenia.

Dlatego wartości domyślne zachowują wszystko, a każde usunięcie jest przełącznikiem, który wybierasz. Jedno ustawienie — Raport i tabele — celowo łamie tę zasadę i usuwa bloki kodu oraz obrazy, bo istnieje po to, żeby przenieść tabelę porównawczą do raportu, w którym zabłąkany fragment jest szumem. To wyjątek, mówi o tym wprost, a ustawienie Domyślne nie usuwa absolutnie niczego.

Rzeczy, które naprawdę nie mają odpowiedzi

Niektóre decyzje nie mają poprawnej wartości domyślnej, tylko kontekst:

• Jak wygląda nagłówek, kiedy nic nie może zrobić z niego nagłówka? Zwykle, wersalikami albo z zachowanym #.
• Jak wygląda tabela bez tabeli? Wyrównane kolumny, tabulatory albo etykieta i wartość.
• Jak wygląda lista zadań? [ ], ☐ albo nic.

Po to istnieją ustawienia gotowe. Zamiast wybrać jedno i nazwać je powszechnym, każde ustawienie odpowiada na wszystkie te pytania dla konkretnego miejsca docelowego — programu pocztowego, arkusza, okna czatu, strony dokumentacji, formularza internetowego — i pokazuje ci przykład, żebyś zobaczył odpowiedzi, zanim im zaufasz.