Was ist eine MD-Datei?

MD ist ein reines Textformat, das sich in jedem Editor öffnen lässt. Eingesetzt wird es für die Bearbeitung und den Austausch zwischen Programmen.

Die Endung lautet .md, der volle Name Markdown. Beides sagt weniger aus als das, was die Datei halten kann — und davon handelt der Rest dieser Seite.

Es geht auf 2004 zurück. Die Spezifikation ist CommonMark.

Das Alter ist aus einem praktischen Grund interessant: je älter ein Format, desto mehr Programme hatten Zeit, es zu lernen.

Sie ist vollständig veröffentlicht, das Format lässt sich also aus dem Dokument umsetzen statt durch Nachsehen. Deshalb taucht es in so vielen Programmen auf, und deshalb gehen Dateien von vor zwanzig Jahren heute noch auf. Veröffentlicht heißt allerdings nicht lizenzfrei: Wo ein Format einen Codec einpackt, ist die Patentfrage eine eigene, die der Standard nicht mitbeantwortet.

Visual Studio Code, Obsidian und Typora lesen es, und die meisten Programme derselben Art ebenfalls.

Wenn eine Datei nicht aufgeht, liegt es selten am Format — häufiger daran, dass das Programm älter ist als das Format. Die Umwandlung in etwas Älteres ist der verlässliche Weg daran vorbei, und dafür gibt es den Rest dieser Website.

Kein Browser liest es.

Das ist der häufigste Grund, es umzuwandeln: nicht dass das Format schlecht wäre, sondern dass die Stelle, an der die Datei erscheinen soll, es nicht lesen kann.

MD ist zum Öffnen und Ändern gedacht. Behalte die Datei in diesem Format, solange die Arbeit läuft, und exportiere daraus, wann immer eine fertige Fassung gebraucht wird.

HTML von Hand zu schreiben ist mühsam, und eine Textverarbeitung erzeugt eine Datei, die niemand vernünftig vergleichen kann. Markdown sammelt Konventionen, die in reinen Text-E-Mails längst gebräuchlich waren, bevor sie einen Namen bekamen: eine Zeile mit Raute davor ist eine Überschrift, Sternchen um ein Wort machen es fett, ein Bindestrich am Zeilenanfang macht eine Aufzählung. Der Kern der Idee ist, dass die Quelle lesbar bleibt, auch für jemanden, der das Format noch nie gesehen hat.

Genau diese Eigenschaft hat der Dokumentation den Weg geebnet. Eine README, ein Änderungsprotokoll, eine technische Notiz oder ein Blogbeitrag in Markdown ist eine Textdatei — sie gehört in die Versionsverwaltung, zwei Personen können sie parallel bearbeiten und das Ergebnis zusammenführen, und ein Reviewer liest den Unterschied, ohne irgendetwas erst darzustellen. Kein binäres Textverarbeitungsformat erlaubt irgendetwas davon.

Die ursprüngliche Beschreibung von 2004 war informell und ließ vieles offen, also haben verschiedene Programme die Lücken unterschiedlich gefüllt. CommonMark ist der ernsthafte Versuch einer präzisen Spezifikation und das, woran sich die meisten modernen Editoren halten. GitHub Flavored Markdown ist CommonMark plus eine Handvoll Erweiterungen, und es ist die Ausprägung, mit der die meisten Menschen tatsächlich gearbeitet haben.

Am häufigsten stiftet dabei eine Sache Verwirrung: Tabellen. Mit Pipe-Zeichen abgetrennte Tabellen sind kein Teil von CommonMark — sie sind eine Erweiterung von GitHub, die auch viele Editoren und statische Website-Generatoren unterstützen, in strengen Umsetzungen aber fehlt. Eine Tabelle, die in einem Repository perfekt aussieht und woanders als Zeile aus Pipe-Zeichen ankommt, ist keine kaputte Datei — das Werkzeug implementiert nur diese Erweiterung nicht. Aufgabenlisten, Durchstreichen und automatische Verlinkung fallen in dieselbe Kategorie.

Viele Markdown-Dateien beginnen mit einem von drei Bindestrichen eingerahmten Block, der etwa Titel, Datum und eine Liste von Schlagworten enthält. Das ist Front Matter — meist YAML, gelegentlich TOML oder JSON — und es ist gar kein Markdown. Statische Website-Generatoren, Notiz-Anwendungen und Dokumentationswerkzeuge lesen es als Metadaten über das Dokument und entfernen es vor der Darstellung.

Ein Werkzeug, das Front Matter nicht kennt, zeigt es als reinen Text oben auf der Seite. Beginnt ein umgewandeltes Dokument mit drei Bindestrichen und einer Liste von Schlüssel-Wert-Paaren, ist genau das passiert — der Block vor dem Umwandeln zu löschen behebt es.

Es gibt keine Seitengröße, keinen Rand, keine Schriftart, keinen Zeilenabstand, keinen Seitenumbruch und keine Fußzeile. Das ist Absicht, kein Mangel: Die Datei beschreibt Struktur — dies ist eine Überschrift, dies ist ein Zitat, dies ist Code — und überlässt das Aussehen dem, was sie am Ende darstellt. Dasselbe Dokument wird zur Webseite, zum PDF und zur Präsentation, ohne umgeschrieben zu werden.

Auch Kommentare, nachverfolgte Änderungen und ein „das ist die dritte Fassung dieses Absatzes" gibt es nicht. Diese Aufgabe übernimmt die Versionsverwaltung, und sie erledigt sie besser — genau das ist der Tausch, den das Format eingeht. Braucht ein Dokument einen Review-Workflow statt einer Historie, ist eine Textverarbeitung ehrlicherweise das richtigere Werkzeug.

Das übliche Ziel ist PDF, für alles, was an jemanden geht, dem egal ist, womit es geschrieben wurde — eine Spezifikation für einen Kunden, ein Notizenpaket, ein Handbuch. Die Umwandlung macht aus den Strukturzeichen echte Formatierung: Überschriften werden zu Überschriften, Codeblöcke behalten ihre feste Zeichenbreite, Listen ihre Verschachtelung.

HTML ist ein weiteres gängiges Ziel und liegt näher an einer Übersetzung als an einer Umwandlung, weil Markdown von Anfang an als Kurzschrift dafür gedacht war — Werkzeuge wie Pandoc oder ein statischer Website-Generator übernehmen das. Diese Seite selbst wandelt Markdown nach PDF um; für eine DOCX-Datei, etwa weil jemand nur eine Word-Datei mit Änderungsverfolgung akzeptiert, braucht es ein anderes Werkzeug.

Eine Markdown-Datei, die sechs Diagramme zeigt, enthält keine Diagramme. Sie enthält sechs Pfade, und die Bilder liegen daneben — auf der Festplatte oder auf einem Server. Verschiebt man die Datei ohne den zugehörigen Ordner, sind alle Bilder weg.

Das wirkt sich beim Umwandeln aus. Ein Konverter kann nur ein Bild einbetten, das er auch findet, also müssen relative Pfade von dem Ort aus aufgelöst werden, an dem die Datei tatsächlich liegt. Es fällt auch auf, wenn ein Dokument per Mail verschickt wird: Eine .md-Datei ohne die zugehörigen Bilder zu verschicken heißt, das Gerippe zu verschicken. Kommt es auf die Bilder an, ist PDF das richtige Ziel, weil dort am Ende alles in einer einzigen Datei steckt.

Jeder Texteditor genügt — Editor, TextEdit, nano —, weil die Datei reiner Text ist. Genau das ist der ganze Reiz, und deshalb öffnet sich eine 2004 geschriebene Markdown-Datei heute ohne jede Installation.

Spezialisierte Editoren fügen eine Live-Vorschau hinzu, die beim Schreiben genuin hilfreich und für die Datei selbst völlig belanglos ist. Visual Studio Code, Obsidian und Typora stellen alle beim Tippen dar; keiner speichert etwas, das die anderen nicht lesen könnten. Sich für eines zu entscheiden ist eine Vorliebe, keine Festlegung — mehr lässt sich von den meisten Dokumentformaten nicht behaupten.