Was ist eine .md-Datei? Markdown erklärt

Autor: Veröffentlicht

Kurz erklärt: Eine .md-Datei ist meist eine einfache Textdatei in Markdown — einer einfachen Schreibweise für Überschriften, Listen, Links und andere Dokumentelemente. Du kannst sie in jedem Texteditor öffnen. Ein Programm mit Markdown-Unterstützung zeigt zusätzlich die formatierte Ansicht. Solche Dateien werden häufig für Anleitungen, Notizen, Dokumentationen und Webseiteninhalte verwendet.

Was bedeutet die Dateiendung .md?

Die Dateiendung .md, also der letzte Teil des Dateinamens, steht in der Regel für Markdown. Das ist eine leichtgewichtige Auszeichnungssprache: Statt die Formatierung über eine Symbolleiste auszuwählen, fügst du einfache Zeichen in den Text ein. Zwei Sternchen auf beiden Seiten eines Wortes kennzeichnen zum Beispiel Fettdruck.

Das Dokument bleibt auch ohne spezielles Programm lesbar. Im Texteditor siehst du den Text und die Auszeichnungszeichen, in der Markdown-Vorschau dagegen den formatierten Inhalt. Die Umwandlung der Auszeichnungen in die sichtbare Darstellung des Dokuments nennt man Rendering.

Anders als eine .docx-Datei speichert ein Markdown-Dokument kein aufwendiges Seitenlayout, etwa eine präzise Anordnung von Elementen oder Druckeinstellungen. Im Mittelpunkt stehen der Inhalt und seine Struktur. Die Dateiendung allein garantiert allerdings keinen bestimmten Inhalt: Dateien lassen sich beliebig benennen. Eine ungewöhnliche .md-Datei muss daher nicht unbedingt gültigen Markdown-Text enthalten.

Wie öffnest du eine .md-Datei und siehst die Formatierung?

Zum Lesen reicht ein einfacher Texteditor, beispielsweise der mit dem Betriebssystem gelieferte Editor. Das ist praktisch, wenn du schnell eine Anleitung prüfen oder einen einzelnen Satz ändern möchtest. Dabei siehst du auch die Zeichen, die für die Formatierung zuständig sind.

Für komfortableres Arbeiten wähle ein Werkzeug mit Markdown-Vorschau:

Wenn ein Doppelklick auf die Datei nicht das richtige Programm öffnet, wähle „Öffnen mit“ und gib einen Texteditor an. Du musst die Dateiendung nicht in .txt ändern. Ein Webbrowser allein zeigt eine lokale .md-Datei nicht immer formatiert an — er kann stattdessen den Rohtext anzeigen oder einen Download anbieten.

Wie sieht Markdown-Syntax in der Praxis aus?

Die grundlegenden Auszeichnungen lassen sich anhand einer kurzen Notiz lernen. Der folgende Ausschnitt enthält eine Überschrift zweiter Ebene, Fettdruck, eine Liste und eine Code-Auszeichnung:

## Vorbereitung der Webseite

**Vor der Veröffentlichung** prüfe:

- die Richtigkeit der Kontaktdaten,
- die Funktion des Formulars,
- die Darstellung der Webseite auf dem Smartphone.

Die Startdatei des Projekts heißt `index.html`.

In der Vorschau erscheinen die Zeichen ## nicht mehr; stattdessen wird der folgende Text als Überschrift dargestellt. Die Sternchen sorgen für Fettdruck, die Bindestriche für eine Aufzählung. Die Backticks um index.html heben den Dateinamen als Code hervor. Eine Leerzeile trennt Absätze oder größere Inhaltselemente voneinander.

Einen Link schreibst du nach dem Muster [Linktext](adresse), ein Bild nach dem Muster ![Bildbeschreibung](pfad-zur-datei). Das Bild ist normalerweise nicht in der .md-Datei selbst eingebettet: Die Angabe verweist auf seinen Speicherort. Wenn du das Dokument verschiebst, musst du deshalb auch auf die Bilddateien und die korrekten Pfade achten.

Es gibt verschiedene Markdown-Varianten mit jeweils eigenen Regeln zur Interpretation der Auszeichnungen. Einfache Überschriften und Listen werden weitgehend unterstützt, Tabellen, Aufgabenlisten oder Fußnoten können sich jedoch je nach Programm unterschiedlich verhalten. Soll das Dokument in einem bestimmten System verwendet werden, prüfe die Vorschau direkt dort.

Wie erstellst du eine .md-Datei und gibst sie weiter?

Du kannst ein neues Dokument erstellen, ohne spezielle Software zu installieren:

  1. Öffne einen einfachen Texteditor und schreibe den Inhalt mit Markdown-Auszeichnungen.
  2. Speichere ihn als Textdatei, am besten mit der Zeichenkodierung UTF-8, damit polnische Sonderzeichen erhalten bleiben.
  3. Vergib einen Namen, zum Beispiel anleitung.md.
  4. Prüfe, ob das Programm automatisch die Endung .txt angehängt und dadurch anleitung.md.txt erzeugt hat.
  5. Öffne das Dokument in einer Markdown-Vorschau und kontrolliere die Formatierung.

Wenn du eine Word-Datei von anleitung.docx in anleitung.md umbenennst, wird das Dokument dadurch nicht konvertiert. Du musst den Inhalt mit einem geeigneten Werkzeug exportieren oder als einfachen Text einfügen und die Auszeichnungen ergänzen.

Soll die empfangende Person die Anleitung bearbeiten, gib die .md-Datei zusammen mit den verwendeten Bildern weiter. Soll sie das fertige Dokument nur lesen, kann ein PDF bequemer sein, das du aus einem Programm mit Markdown-Unterstützung exportierst. Welche Exportformate verfügbar sind, hängt vom gewählten Werkzeug ab.

Wann ist Markdown eine gute Wahl?

Markdown eignet sich für Inhalte, bei denen der Text wichtiger ist als das grafische Layout: für Notizen, Anleitungen und technische Dokumentation. Die verbreitete Datei README.md beschreibt meist ein Projekt, erklärt dessen Start oder enthält Hinweise zur Nutzung. Da es sich um einfachen Text handelt, lassen sich verschiedene Versionen leicht vergleichen und geänderte Sätze erkennen.

.md-Dateien können auch als Quelldateien für Artikel in Website-Generatoren wie Hugo dienen. Ein solches System wandelt den Inhalt in eine Webseite um und gestaltet sie anhand einer Vorlage. Eine Markdown-Datei allein ist jedoch noch keine fertige Website.

Für Dokumente mit einem exakt festgelegten Drucklayout, komplexen Tabellen oder manuell platzierten Elementen ist eine Textverarbeitung oder ein Satzprogramm besser geeignet. Erstelle zum Einstieg eine kurze .md-Notiz und öffne sie gleichzeitig als Text und in der Vorschau — so siehst du sofort den Unterschied zwischen den Auszeichnungen und ihrer Wirkung.

Siehe auch: Was ist 2FA?

Lesen Sie auch

Wie PHP-FPM PHP-Anfragen verarbeitet, sich vom Webserver unterscheidet und wie du Prozesse an Last und Hosting-Ressourcen anpasst.
BIND ist offene DNS-Serversoftware. Erfahre, welche Aufgaben sie übernimmt und wann sich der Betrieb eines eigenen Servers lohnt.
Was Polens REGON-Register und seine Kennnummer bedeuten, wie sie sich von NIP und KRS unterscheiden und wie Sie Unternehmensdaten prüfen.