Jedes Markdown-Element mit einem Beispiel, das du bearbeiten und sofort gerendert sehen kannst: Zeilenumbrüche, Links, Tabellen, Checkboxen, Fußnoten, Codeblöcke und GitHub-Alerts, dazu eine README-Vorlage.
Markdown formatiert reinen Text mit wenigen Zeichen: # für Überschriften, **zwei Sternchen** für Fett, [Text](Adresse) für Links, - für Aufzählungen und drei Backticks für Codeblöcke. Jedes Beispiel unten lässt sich bearbeiten, und die Vorschau daneben aktualisiert sich beim Tippen, sodass du eine Syntax testen kannst, bevor du sie verwendest.
Die fünf, die du am häufigsten brauchst
Achtzehn Live-Beispiele, die alles von Überschriften bis zu Fußnoten und GitHub-Alerts abdecken, eine Tabelle mit den Unterschieden zwischen GitHub und Standard-CommonMark, eine README-Vorlage und ein vollständiger Editor am Ende der Seite.
Beende die Zeile mit zwei Leerzeichen oder einem Backslash und drück dann Enter. Ein einfaches Enter wird als Leerzeichen behandelt, und die Zeilen werden zusammengefügt. Für einen neuen Absatz statt eines Zeilenumbruchs lass eine Leerzeile.
Beginne einen Listeneintrag mit - [ ] für ein leeres Kästchen oder mit - [x] für ein abgehaktes. Aufgabenlisten gehören zu GitHub Flavored Markdown, daher funktionieren sie auf GitHub, GitLab und in den meisten Notiz-Apps, aber nicht in striktem CommonMark.
Schreib die Kopfzeile mit senkrechten Strichen zwischen den Spalten, dann eine Zeile aus Bindestrichen, dann eine Zeile pro Tabellenzeile. Die Spalten müssen im Quelltext nicht bündig sein. Setze Doppelpunkte in die Bindestrich-Zeile, um eine Spalte links, rechts oder zentriert auszurichten.
Markdown ist die ursprüngliche Syntax von 2004, die viele Fälle offenließ. CommonMark ist eine präzise Spezifikation dieser Kernsyntax. GitHub Flavored Markdown ist CommonMark plus Tabellen, Aufgabenlisten, Durchstreichen, automatische Links und Fußnoten, und daran halten sich die meisten Entwicklertools.
Die meisten Renderer erlauben es, daher sind details- und summary-Tags oder ein zentriertes Bild in READMEs üblich. GitHub entfernt aus Sicherheitsgründen Skripte, Styles und einige Attribute. Die Vorschauen auf dieser Seite rendern kein rohes HTML und zeigen es daher als Text.
Ein bis sechs #-Zeichen, dann ein Leerzeichen. Verwende pro Dokument nur eine Überschrift mit einem einzelnen #.
Unterstriche (__bold__, _italic_) funktionieren auch, aber nicht mitten in einem Wort.
Zwei Tilden auf jeder Seite. Teil von GitHub Flavored Markdown, nicht von Kern-CommonMark.
Ein einzelnes Enter bricht die Zeile nicht um. Beende sie mit zwei Leerzeichen oder einem Backslash, oder lass eine Leerzeile für einen neuen Absatz.
Text in eckigen Klammern, Adresse in runden Klammern. Spitze Klammern machen eine nackte Adresse klickbar.
Hält lange Adressen aus dem Text heraus. Die Definitionen können überall stehen und werden nicht angezeigt.
Wie ein Link mit ! davor. Der Text in eckigen Klammern ist der Alt-Text, den Screenreader vorlesen.
Verwende -, * oder + für Aufzählungen und 1. für Nummern. Rücke zum Verschachteln um zwei bis vier Leerzeichen ein.
Ein Leerzeichen zwischen den Klammern ist nicht abgehakt; ein x ist abgehakt. Auf GitHub kannst du sie in Issues anklicken.
Beginne jede Zeile mit >. Eine Zeile nur mit > hält die Absätze in einem Zitat zusammen.
Backticks behalten den Text exakt so bei, wie er getippt wurde. Um einen Backtick anzuzeigen, umschließe ihn mit zwei: `` a`b ``.
Drei Backticks davor und danach. Das Wort nach der öffnenden Begrenzung gibt die Sprache für die Hervorhebung an.
Senkrechte Striche trennen Spalten; die Bindestrich-Zeile ist Pflicht. Doppelpunkte legen die Ausrichtung fest: links, rechts oder zentriert.
Drei oder mehr Bindestriche, Sternchen oder Unterstriche in einer eigenen Zeile. Lass um Bindestriche Leerzeilen, damit sie nicht als Unterstreichung einer Überschrift gelesen werden.
Die Anmerkung wird am Ende des Dokuments mit einem Rücklink gesammelt.
Ein Backslash vor * _ # [ ] ` und ähnlichen Zeichen zeigt sie als reinen Text an.
GitHub wandelt nackte Adressen in Links um. Striktes CommonMark braucht spitze Klammern.
GitHub zeigt sie als farbige Boxen; andere Apps zeigen ein einfaches Zitat, so wie die Vorschau hier.
Markdown-Syntax und wo sie funktioniert
Wo sich GitHub Flavored Markdown von CommonMark unterscheidet
Überall
GitHub und die meisten Apps
Nur GitHub
Markdown (bearbeite mich)
Vorschau
Kopieren
Zurücksetzen
Syntax auf einen Blick
Jedes Element, live
GitHub vs CommonMark
README-Vorlage
Vorlage kopieren
Im Editor öffnen
Vollständiger Editor
Markdown
Markdown kopieren
{n} Wörter. Es wird nichts gespeichert oder gesendet.
Kostenlos starten · Keine Kreditkarte nötig