Was ein Markdown-Entferner wegwirft, und wie man es behält

„Das Markdown entfernen“ klingt nach einem einzigen Vorgang. In Wirklichkeit ist es eine Reihe kleiner Entscheidungen, und ein Konverter trifft jede einzelne für Sie, ob er es zugibt oder nicht.

Hier ist, was üblicherweise schlecht entschieden wird.

Die Listennummerierung

Die folgenreichste. Die üblichen Bibliotheken behandeln eine Liste als Formatierungskonstrukt und flachen sie ab, was 1. 2. 3. zusammen mit den Aufzählungszeichen entfernt.

Bei einer Aufzählungsliste ist das vertretbar. Bei einer nummerierten zerstört es die Bedeutung: die Nummern bezogen sich auf etwas. Antworten auf einen nummerierten Fragebogen, Schritte in einer Abfolge, nach Rang geordnete Punkte — alles wird zu einem ungeordneten Haufen.

Die Nummerierung bleibt hier erhalten, auch bei Listen, die bei 7 beginnen, und auch bei einer nummerierten Liste, die in einer anderen steckt.

Die URL hinter einem Link

[die Doku](https://example.com/guide) enthält zwei Informationen. Reiner Text hat keinen Ort für die zweite, ein Konverter muss sie also entweder ausschreiben oder verwerfen.

Sie zu verwerfen geschieht stillschweigend und häufig. Der Leser bekommt „die Doku“ und keine Möglichkeit, dorthin zu gelangen. Die Voreinstellung schreibt hier beides — die Doku (https://example.com/guide) — denn ein Leser, der dem Link nicht folgen kann, hat etwas verloren. Nur-Text und Nur-URL stehen bereit, wenn Sie wissen, dass der Link keine Rolle spielt.

Die Sprache eines Codeblocks

Ein mit ```java markierter Block trägt eine Tatsache: das ist Java. Entfernen Sie die Markierung, und diese Tatsache geht mit ihr, zurück bleibt ein Block unerklärter Symbole, der alles Mögliche sein könnte.

Die Sprache wird als Kennzeichnung ausgegeben — [java] — damit ein Leser es erkennen kann. Aus, oder als ursprüngliche Markierung behalten, wenn Sie das lieber mögen.

Der Alternativtext eines Bildes

Ein Bild kann nicht als Bild überleben. Aber sein Alternativtext ist ein Satz, den jemand geschrieben hat, um es zu beschreiben, und oft ist er die einzige Beschreibung dieses Inhalts im Dokument. Das Bild zu verwerfen und die Beschreibung zu behalten ist meist besser, als beides zu verwerfen.

Fußnoten, Zitate, Trennlinien, Frontmatter

Jedes davon ist Inhalt, den ein Entferner stillschweigend beseitigen kann. Jedes bleibt hier standardmäßig erhalten und ist einzeln abschaltbar.

Warum verlustfrei die richtige Voreinstellung ist

Der Test, der die meisten dieser Fälle klärt: könnte ein Leser, der die Eingabe nie gesehen hat, allein aus der Ausgabe alles verstehen, was sie gesagt hat?

Lautet die Antwort nein, hat der Konverter im Namen des Lesers Information weggeworfen, ohne zu fragen. Ein Konverter, der etwas übrig lässt, das Sie selbst löschen müssen, ist zehn Sekunden lang lästig. Einer, der etwas löscht, das Sie gebraucht hätten, ist ein Problem, das Sie vielleicht erst bemerken, wenn es darauf ankommt.

Die Voreinstellungen behalten also alles, und jede Entfernung ist ein Schalter, den Sie wählen. Eine Voreinstellung — Bericht und Tabellen — bricht diese Regel absichtlich und entfernt Codeblöcke und Bilder, denn sie existiert, um eine Vergleichstabelle in einen Bericht zu heben, in dem ein versprengter Schnipsel Rauschen ist. Sie ist die Ausnahme, sie sagt das auch, und die Voreinstellung Standard entfernt überhaupt nichts.

Die Dinge, auf die es wirklich keine Antwort gibt

Manche Entscheidungen haben keine richtige Voreinstellung, nur einen Zusammenhang:

• Wie sieht eine Überschrift aus, wenn nichts sie zur Überschrift machen kann? Einfach, Großbuchstaben, oder # behalten.
• Wie sieht eine Tabelle ohne Tabelle aus? Ausgerichtete Spalten, Tabulatoren, oder Bezeichnung und Wert.
• Wie sieht eine Aufgabenliste aus? [ ], ☐, oder nichts.

Dafür gibt es die Voreinstellungen. Statt eine auszuwählen und für allgemeingültig zu erklären, beantwortet jede Voreinstellung all diese Fragen für ein bestimmtes Ziel — ein E-Mail-Programm, eine Tabellenkalkulation, ein Chatfenster, eine Dokumentationsseite, ein Webformular — und zeigt Ihnen ein Beispiel, damit Sie die Antworten sehen, bevor Sie ihnen vertrauen.