Markdown-Vorschau

Über die Markdown-Vorschau

Markdown ist der schmerzloseste Weg, Dokumentation, Anleitungen und READMEs zu schreiben — reiner Text, leicht zu bearbeiten, leicht zu versionieren. Der Haken: Man sieht das Ergebnis beim Schreiben nicht. Dieses Werkzeug schließt die Lücke: links tippen, rechts sehen.

Unterstützte Syntax

• Überschriften: ein bis sechs # am Zeilenanfang für H1 bis H6. Beachten Sie, dass das Leerzeichen nach dem # erforderlich ist.
• Betonung: *kursiv*, **fett**, ***fett kursiv***, ~~durchgestrichen~~.
• Listen: - oder * beginnt eine ungeordnete Liste, 1. eine geordnete; zum Verschachteln mit vier Leerzeichen oder einem Tabulator einrücken.
• Aufgabenlisten: - [ ] offen und - [x] erledigt werden als Kontrollkästchen dargestellt.
• Tabellen: Zellen durch senkrechte Striche getrennt, wobei die zweite Zeile mit --- die Kopfzeile markiert und Doppelpunkte die Ausrichtung steuern.
• Code: Inline-Code in Backticks; mehrzeiliger Code mit drei Backticks umschlossen, optional gefolgt von einem Sprachnamen.
• Blockzitate: ein führendes >, verschachtelbar.
• Links und Bilder: [Text](url) und ![alt](url).
• Horizontale Linie: drei oder mehr -, * oder _ in einer eigenen Zeile.

Wie man eine Tabelle schreibt

Tabellen sind der Teil von Markdown, den man am häufigsten falsch macht. Das Format ist:

| Name  | Team     | Betrag |
|:------|:--------:|-------:|
| Alice | Technik  |   1200 |
| Bob   | Marketing|    980 |

Drei Punkte: Sowohl die Kopfzeile als auch die Trennzeile sind erforderlich; die Doppelpunkte in der Trennzeile steuern die Ausrichtung (Doppelpunkt links für links, beidseitig für zentriert, Doppelpunkt rechts für rechts); und es ist am besten, die Anzahl der Striche pro Zeile einheitlich zu halten — das Rendern übersteht Uneinheitlichkeit, aber die Quelle liest sich besser, wenn sie ausgerichtet ist.

Sprachmarkierungen an Codeblöcken

Ein Sprachname nach den drei Backticks (etwa ```javascript) lässt die meisten Editoren Syntaxhervorhebung anwenden. Dieses Werkzeug gibt anhand des Sprachnamens einen passenden Stilhinweis, während der Originaltext erhalten bleibt, sodass Sie ihn anderswo einfügen können.

Beachten Sie, dass Inhalte in einem Codeblock nicht als Markdown geparst werden, das Schreiben von # oder Sternchen dort also sicher ist — sie werden nicht zu Überschriften oder Kursivschrift. Genau deshalb gehören eingefügte Fehlerprotokolle oder Konfigurationsdateien in einen Codeblock.

Die Falle mit dem Zeilenumbruch

In Standard-Markdown erzeugt ein einzelner Zeilenumbruch keinen Zeilenumbruch — für einen neuen Absatz brauchen Sie eine Leerzeile, für einen erzwungenen Umbruch zwei nachgestellte Leerzeichen. Das ist unbequem für chinesische Autoren, die frei Zeilen umbrechen.

Deshalb ist in diesem Werkzeug „einzelner Zeilenumbruch bricht ebenfalls" standardmäßig aktiviert, was der Intuition entspricht. Wenn Sie ein Dokument erzeugen, das strikt standardkonform sein muss (etwa für einen statischen Seitengenerator), deaktivieren Sie es.

Wann man Markdown verwendet

• Gut geeignet: technische Dokumentation, READMEs, Besprechungsnotizen, Anforderungen, Blogentwürfe, persönliche Notizen — alles Inhaltsschwere, Layoutleichte und über die Zeit Gepflegte.
• Weniger gut: formelle Dokumente mit feiner Layoutkontrolle, gemischtem Text und Bildern oder mehrspaltigem Design. Für diese ist eine klassische Textverarbeitung direkter.

Export und Migration

Es gibt drei Ausgänge:

• Markdown kopieren: die reine Textquelle, überall einfügbar, wo Markdown unterstützt wird.
• HTML kopieren: das gerenderte HTML-Fragment, bereit zur Einbettung in Ihre eigene Seite. Beachten Sie, dass es kein Stylesheet mitbringt — das CSS für ein gutes Aussehen liefern Sie.
• .md herunterladen: als Datei gespeichert für Versionsverwaltung oder Archivierung.

Alles geschieht im Browser, und nichts von dem, was Sie schreiben, verlässt Ihren Rechner. Zur Prüfung öffnen Sie das Netzwerk-Panel mit F12 — beim Tippen werden überhaupt keine Anfragen gesendet.

Verwandte Werkzeuge