Übersicht

Fast alle Markdown-Anwendungen unterstützen die grundlegende Syntax, die im ursprünglichen Markdown-Design-Dokument beschrieben ist. Es gibt kleinere Abweichungen und Unterschiede zwischen Markdown-Prozessoren – diese werden, wenn möglich, inline vermerkt.

Überschriften

Um eine Überschrift zu erstellen, füge vor einem Wort oder einer Phrase eine Anzahl von Nummernzeichen ( # ) hinzu. Die Anzahl der Nummernzeichen entspricht der Ebene der Überschrift. Zum Beispiel wird eine Überschrift der Stufe drei ( <h3> ) mit drei Nummernzeichen erstellt (z. B. ### Meine Überschrift ).

Alternative Syntax

Alternativ kannst du unterhalb des Textes eine beliebige Anzahl von == -Zeichen für eine Überschrift der Ebene 1 oder -- -Zeichen für eine Überschrift der Ebene 2 hinzufügen.

Beste Praktiken für Überschriften

Markdown-Anwendungen sind uneinig darüber, wie sie mit fehlenden Leerzeichen zwischen den Nummernzeichen ( # ) und dem Überschriftennamen umgehen. Um Kompatibilität zu gewährleisten, setze immer ein Leerzeichen zwischen die Nummernzeichen und den Überschriftennamen.

Absätze

Um Absätze zu erstellen, trenne Abschnitte mit einer Leerzeile.

Zeilenumbrüche

Um einen Zeilenumbruch oder eine neue Zeile ( <br> ) zu erzeugen, beende eine Zeile mit zwei oder mehr Leerzeichen und drücke dann die Eingabetaste.

Hervorhebung

Du kannst Text fett oder kursiv hervorheben.

Fett

Um Text fett zu formatieren, setze zwei Sternchen oder Unterstriche vor und nach ein Wort oder eine Phrase.

Kursivschrift

Um Text kursiv zu formatieren, füge ein Sternchen oder einen Unterstrich vor und nach einem Wort oder einer Phrase hinzu. Um die Mitte eines Wortes zur Betonung kursiv zu setzen, verwende ein einzelnes Sternchen ohne Leerzeichen um die Buchstaben herum.

Beste Praktiken für Kursivschrift

Markdown-Anwendungen sind sich uneinig darüber, wie sie mit Unterstrichen in der Mitte eines Wortes umgehen. Um Kompatibilität zu gewährleisten, verwende Sternchen für Kursivschrift in der Mitte eines Wortes.

Fett und Kursiv

Um Text sowohl fett als auch kursiv zu formatieren, füge drei Sternchen oder Unterstriche vor und nach einem Wort oder einer Phrase hinzu. Um die Mitte eines Wortes fett und kursiv zu setzen, verwende drei Sternchen ohne Leerzeichen um die Buchstaben herum.

Blockzitate

Um ein Blockzitat zu erstellen, setze ein > vor einen Absatz.

Dorothy folgte ihr durch viele der wunderschönen Räume in ihrem Schloss.

Listen

Du kannst Elemente in geordnete und ungeordnete Listen einteilen.

Geordnete Listen

Um eine geordnete Liste zu erstellen, füge Listenelemente mit Zahlen gefolgt von einem Punkt hinzu. Die Zahlen müssen nicht in numerischer Reihenfolge sein, aber die Liste sollte mit der Zahl eins beginnen.

Beste Praktiken für geordnete Listen

CommonMark und einige andere leichtgewichtige Markup-Sprachen erlauben die Verwendung einer Klammer ( ) ) als Trennzeichen (z. B. 1) Erstes Element ), aber nicht alle Markdown-Anwendungen unterstützen dies. Daher ist es aus Kompatibilitätsgründen besser, nur Punkte zu verwenden.

Ungeordnete Listen

Um eine ungeordnete Liste zu erstellen, füge Striche ( - ), Sternchen ( * ) oder Pluszeichen ( + ) vor Listenelemente. Indentiere ein oder mehrere Elemente, um eine verschachtelte Liste zu erstellen.

Ungeordnete Listenelemente mit Zahlen beginnen

Falls du eine ungeordnete Liste mit einer Zahl gefolgt von einem Punkt beginnen möchtest, kannst du einen Backslash ( \ ) verwenden, um den Punkt zu maskieren .

Beste Praktiken für ungeordnete Listen

Markdown-Anwendungen sind sich uneinig darüber, wie verschiedene Trennzeichen in derselben Liste behandelt werden. Um Kompatibilitätsprobleme zu vermeiden, mische keine unterschiedlichen Trennzeichen in derselben Liste – entscheide dich für eines und bleibe dabei.

Elemente in Listen hinzufügen

Um ein weiteres Element in einer Liste hinzuzufügen und die Kontinuität der Liste beizubehalten, rücke das Element mit vier Leerzeichen oder einem Tab ein, wie in den folgenden Beispielen gezeigt.

Absätze

Das gerenderte Ergebnis sieht so aus:

• Dies ist das erste Listenelement.

• Hier ist das zweite Listenelement.

  Ich muss einen weiteren Absatz unterhalb des zweiten Listenelements hinzufügen.

• Und hier ist das dritte Listenelement.

Blockzitate

Das gerenderte Ergebnis sieht so aus:

• Dies ist das erste Listenelement.

• Hier ist das zweite Listenelement.

  Ein Blockzitat würde sich unterhalb des zweiten Listenelements gut machen.

• Und hier ist das dritte Listenelement.

Code-Blöcke

Code-Blöcke werden normalerweise mit vier Leerzeichen oder einem Tab eingerückt. Wenn sie sich in einer Liste befinden, müssen sie mit acht Leerzeichen oder zwei Tabs eingerückt werden.

Das gerenderte Ergebnis sieht so aus:

1. Öffne die Datei.

2. Finde den folgenden Code-Block in Zeile 21:

   
   							<html> <head> <title>Test</title> </head>
   						

3. Aktualisiere den Titel, sodass er dem Namen deiner Website entspricht.

Bilder

Das gerenderte Ergebnis sieht so aus:

1. Öffne die Datei, die das Linux-Maskottchen enthält.

2. Bewundere seine Schönheit.

   

3. Schließe die Datei.

Listen

Du kannst eine ungeordnete Liste in einer geordneten Liste verschachteln oder umgekehrt.

Das gerenderte Ergebnis sieht so aus:

1. Erstes Element
2. Zweites Element
3. Drittes Element
   • Eingerücktes Element
   • Eingerücktes Element
4. Viertes Element

Code

Um ein Wort oder eine Phrase als Code zu kennzeichnen, setze es in Backticks ( ` ).

Backticks maskieren

Falls das Wort oder die Phrase, die du als Code kennzeichnen möchtest, selbst Backticks enthält, kannst du es mit doppelten Backticks ( `` ) maskieren.

Code-Blöcke

Um Code-Blöcke zu erstellen, rücke jede Zeile des Blocks mit mindestens vier Leerzeichen oder einem Tab ein.

Das gerenderte Ergebnis sieht so aus:

					<html> <head> </head></html>
				

Horizontale Linien

Um eine horizontale Linie zu erstellen, verwende drei oder mehr Sternchen ( *** ), Bindestriche ( --- ) oder Unterstriche ( ___ ) auf einer eigenen Zeile.

Das gerenderte Ergebnis sieht identisch aus:

Beste Praktiken für horizontale Linien

Setze zur besseren Lesbarkeit Leerzeilen vor und nach horizontalen Linien.

Links

Um einen Link zu erstellen, setze den Linktext in eckige Klammern (z. B. [Duck Duck Go] ) und folge ihm direkt mit der URL in runden Klammern (z. B. (https://duckduckgo.com) ).

Das gerenderte Ergebnis sieht so aus:

Meine Lieblingssuchmaschine ist Duck Duck Go .

Titel hinzufügen

Du kannst optional einen Titel für einen Link hinzufügen. Dieser erscheint als Tooltip, wenn der Benutzer mit der Maus über den Link fährt. Um einen Titel hinzuzufügen, setze ihn in Anführungszeichen hinter die URL.

Das gerenderte Ergebnis sieht so aus:

Meine Lieblingssuchmaschine ist Duck Duck Go .

URLs und E-Mail-Adressen

Um eine URL oder eine E-Mail-Adresse schnell in einen Link zu verwandeln, setze sie in spitze Klammern.

Das gerenderte Ergebnis sieht so aus:

https://www.markdownguide.org
fake@example.com

Links formatieren

Um Links zu hervorheben , setze Sternchen vor und nach den Klammern und Klammern. Um Links als Code zu kennzeichnen, setze sie in Backticks.

Das gerenderte Ergebnis sieht so aus:

Ich unterstütze gerne die EFF .
Dies ist der Markdown Guide .
Sieh dir den Abschnitt über Code an.

Referenzstil-Links

Referenzstil-Links sind eine spezielle Art von Links, die es einfacher machen, URLs in Markdown darzustellen und zu lesen. Sie bestehen aus zwei Teilen: Der erste Teil bleibt direkt im Text, während der zweite Teil irgendwo anders in der Datei gespeichert wird, um die Lesbarkeit zu verbessern.

Den ersten Teil des Links formatieren

Der erste Teil eines Referenzstil-Links wird mit zwei Sätzen von eckigen Klammern formatiert. Der erste Satz enthält den verlinkten Text, während der zweite Satz eine Kennung enthält, die auf den zweiten Teil des Links verweist.

Den zweiten Teil des Links formatieren

Der zweite Teil eines Referenzstil-Links enthält:

1. Die Kennung in eckigen Klammern, gefolgt von einem Doppelpunkt und einem Leerzeichen (z. B. [Kennung]: ).
2. Die URL für den Link, optional in spitzen Klammern.
3. Den optionalen Titel für den Link in Anführungszeichen.

Das gerenderte Ergebnis sieht so aus:

In einem Loch im Boden lebte ein Hobbit. Es war ein Hobbit-Loch , und das bedeutet Gemütlichkeit.

Beste Praktiken für Links

Markdown-Anwendungen sind sich nicht einig, wie sie mit Leerzeichen in URLs umgehen. Um Kompatibilitätsprobleme zu vermeiden, ersetze Leerzeichen durch %20 . Alternativ kannst du, falls deine Markdown-Anwendung HTML unterstützt , den a -Tag verwenden.

Bilder

Um ein Bild einzufügen, setze ein Ausrufezeichen ( ! ) vor den Alternativtext in eckigen Klammern und die Bild-URL in runden Klammern.

Das gerenderte Ergebnis sieht so aus:

Bilder verlinken

Um ein Bild mit einem Link zu versehen, setze den Markdown-Code für das Bild in eckige Klammern und füge danach die URL in runden Klammern hinzu.

Das gerenderte Ergebnis sieht so aus:

Sonderzeichen maskieren

Um ein Zeichen darzustellen, das normalerweise für die Formatierung in Markdown verwendet wird, setze einen Backslash ( \ ) davor.

Zeichen
Name\Backslash (Schrägstrich)
` Backtick (siehe auch Backticks in Code maskieren )
* Sternchen
_ Unterstrich
{ } Geschweifte Klammern
[ ] Eckige Klammern
< > Spitze Klammern
( ) Runde Klammern
# Rautezeichen
+ Pluszeichen
- Minuszeichen (Bindestrich)
. Punkt
! Ausrufezeichen
| Pipe (siehe auch < href="https://www.markdownguide.org/extended-syntax/#escaping-pipe-characters-in-tables">Pipe in Tabellen maskieren)

HTML

Viele Markdown-Anwendungen erlauben die Verwendung von HTML-Tags in Markdown-Texten. Dies ist nützlich, wenn du bestimmte HTML-Tags der Markdown-Syntax vorziehst. Zum Beispiel finden manche Leute HTML-Tags für Bilder einfacher. HTML kann auch hilfreich sein, wenn du Attribute eines Elements ändern möchtest, z. B. die < href="https://www.markdownguide.org/hacks/#color">Farbe eines Textes oder die Breite eines Bildes.

Um HTML zu verwenden, setze die Tags in den Text deiner Markdown-Datei.

Das gerenderte Ergebnis sieht so aus:

Dieses Wort ist fett. Dieses Wort ist kursiv.

Beste Praktiken für HTML

Aus Sicherheitsgründen unterstützen nicht alle Markdown-Anwendungen HTML in Markdown-Dokumenten. Falls du unsicher bist, überprüfe die Dokumentation deiner Markdown-Anwendung. Manche Anwendungen unterstützen nur eine eingeschränkte Auswahl an HTML-Tags.

Verwende Leerzeilen, um blockbasierte HTML-Elemente wie <div> , <table> , <pre> und <p> vom umliegenden Inhalt zu trennen. Vermeide das Einrücken von Tags mit Tabs oder Leerzeichen, da dies das Format beeinträchtigen kann.

Quelle: https://www.markdownguide.org/getting-started/