Markdown formatieren

So funktioniert es

Eine README, an der mehrere Personen schreiben, oder eine über Jahre geführte Notizdatei gerät mit der Zeit durcheinander: Manche Punkte beginnen mit *, andere mit -, Tabellenspalten stehen schief, Überschriften kleben am Absatz. Fügen Sie den Text links ein. Rechts beginnt danach jeder Listenpunkt mit dem gewählten Zeichen, Unterpunkte sind um zwei Leerzeichen eingerückt, Nummern wie 1) werden zu 1. und Tabellen werden Spalte für Spalte ausgerichtet. Eine Zeile wie |Befehl|Beschreibung| und die Zeilen darunter werden bis zur breitesten Zelle mit Leerzeichen aufgefüllt, sodass gerade Spalten entstehen; Markierungen wie :- und -: bleiben erhalten. Zwischen Überschriften, Absätzen, Listen und Codeblöcken steht je eine Leerzeile. Den Inhalt von Codeblöcken (mit ``` geöffnet) fasst das Werkzeug nicht an, und Ihre Zeilenumbrüche in Absätzen bleiben, wo sie sind. Die Ergebniszeile nennt Zeilen, Listenpunkte und Tabellen oder meldet, dass der Text schon sauber war.

Dieses Werkzeug ist auch als markdown formatieren, markdown formatter, markdown tabelle ausrichten, readme formatieren, markdown beautifier, markdown aufraeumen online bekannt.

Was ist Markdown?

Markdown formatiert reinen Text mit wenigen Zeichen: # ergibt eine Überschrift, * oder - einen Listenpunkt, ** Fettschrift und ` Code. README-Dateien auf GitHub, viele Notiz-Apps und Dokumentationsseiten nutzen es. Markdown soll auch als Rohtext lesbar sein; deshalb zählt bei Teamarbeit eine saubere Quelle mit ausgerichteten Tabellen und einheitlichen Listenzeichen.

Was ist Markdown-Tabelle (GFM)?

Markdown-Tabellen stammen aus GitHub Flavored Markdown (GFM): Zellen werden mit | getrennt, die Zeile --- unter der Kopfzeile definiert die Tabelle, und :--, --: sowie :-: legen fest, ob eine Spalte links, rechts oder zentriert steht. Die gerenderte Tabelle hängt nicht von der Breite der Rohzellen ab, doch ohne ausgerichtete Spalten ist sie im Quelltext kaum lesbar oder bearbeitbar.

Was ist der Unterschied zwischen Markdown formatieren und Markdown in HTML umwandeln?

Formatieren lässt Markdown Markdown sein und räumt nur den Rohtext auf: ein Listenzeichen, ausgerichtete Tabellen, einheitliche Leerzeilen. Das Ergebnis kommt zurück in dieselbe README. Umwandeln in HTML macht aus Markdown Webseiten-Code: Eine #-Überschrift wird zum <h1>-Tag, ein Listenpunkt zu <li>, und das Ergebnis landet in einer Webseite oder E-Mail. Diese Seite erledigt das Erste; für das Zweite nutzen Sie das Werkzeug Markdown in HTML.

Ändert das Formatieren die Darstellung des Markdowns?

Nein. GitHub, GitLab oder eine Notiz-App ignorieren beim Umwandeln in HTML zusätzliche Leerzeichen und welches Listenzeichen Sie verwendet haben; der aufgeräumte Text ergibt dieselbe Seite. Besser wird die Lesbarkeit des Rohtexts: Die Tabelle lässt sich auch als Text lesen, Änderungen verschiedener Personen sehen gleich aus und Diffs in der Versionskontrolle werden kleiner.

Eines sollten Sie wissen: Nach den Markdown-Regeln sind aufeinanderfolgende Zeilen mit verschiedenen Zeichen (* und +) zwei getrennte Listen. Das Werkzeug lässt sie getrennt und schreibt die zweite Liste mit dem anderen Zeichen. Soll es eine Liste sein, beginnen Sie alle Punkte mit demselben Zeichen.

Bindestrich oder Sternchen?

Beide sind gültig und sehen gerendert gleich aus. GitHubs eigene Doku, Prettier und die meisten Open-Source-Projekte nutzen den Bindestrich (-); das Sternchen (*) ist in älteren Dokumenten und manchen Notiz-Apps verbreitet. Nehmen Sie, was in Ihrem Projekt überwiegt; wichtig ist, dass die Datei einheitlich ist.

Folgen zwei getrennte Listen aufeinander, schreibt das Werkzeug die zweite mit dem anderen Zeichen, damit Markdown sie nicht zusammenlegt. Nummerierte Listen verwenden Zahl und Punkt (1.); die Form 1) wird ebenfalls umgestellt.

• GitHub-README, Open-Source-Projekt → - Bindestrich
• Anpassung an ältere Doku oder Teamgewohnheit → * Sternchen
• Nummerierte Schritte → 1. 2. 3. (das Werkzeug korrigiert sie)

Häufige Fragen

Wie richte ich eine Markdown-Tabelle aus?

Fügen Sie die Tabelle links auf dieser Seite ein. Jede Spalte wird bis zur breitesten Zelle aufgefüllt, die Trennzeile entsprechend verbreitert und Ausrichtungszeichen (:--, --:, :-:) bleiben erhalten. Der Zellinhalt ändert sich nicht.

Ändert das Werkzeug den Inhalt meiner Codeblöcke?

Nein. Jedes Zeichen in einem mit ``` oder ~~~ geöffneten Block bleibt, wie es ist; nur davor und danach wird eine Leerzeile gesetzt.

Werden Zeilen in meinen Absätzen zusammengefügt oder umbrochen?

Nein. Zeilenumbrüche innerhalb von Absätzen bleiben erhalten; das Werkzeug bricht lange Zeilen nicht um und fügt kurze nicht zusammen.

Wird mein Text an einen Server geschickt?

Nein. Das Formatieren läuft vollständig in Ihrem Browser; der eingefügte Text verlässt diese Seite nicht und wird nirgends gespeichert.