Markdown-Syntax-Guide
Wichtige Syntax für formatierte Dokumente
Überblick
Markdown ist eine leichtgewichtige Auszeichnungssprache für formatierte Klartext-Dokumente. Seit 2004 (John Gruber) eine der weltweit beliebtesten Auszeichnungssprachen.
Anders als bei WYSIWYG-Editoren wie Word formatierst du in Markdown per Syntax. Du markierst im Text, welche Wörter und Phrasen anders dargestellt werden sollen.
Überschriften
Überschriften erzeugst du mit # vor einem Wort oder einer Phrase. Die Anzahl der # entspricht der Ebene (z. B. ### für Ebene 3).
Heading level 1
Heading level 2
Heading level 3
Heading level 4
Heading level 5
Heading level 6
Absätze
Absätze entstehen durch Leerzeilen zwischen Textzeilen.
It lets me write easily.
<p>It lets me write easily.</p>
I really like using Markdown.
It lets me write easily.
Zeilenumbrüche
Für einen Zeilenumbruch die Zeile mit zwei oder mehr Leerzeichen beenden, dann Enter.
And this is the second line.
And this is the second line.</p>
This is the first line.
And this is the second line.
Hervorhebung
Hervorhebung durch Fett oder Kursiv.
Fett
Mit ** oder __ vor und nach einem Wort oder einer Phrase.
I just love bold text.
I just love bold text.
Kursiv
Mit * oder _ vor und nach einem Wort oder einer Phrase.
The cat meows.
The cat meows.
Fett und Kursiv
Mit *** oder ___ vor und nach einem Wort oder einer Phrase.
This text is really important.
This text is really important.
Blockzitate
Blockzitat: > vor einen Absatz setzen.
Dorothy followed her through many of the beautiful rooms in her castle.
Verschachtelte Blockzitate
Verschachteln mit >> vor dem Absatz.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Listen
Geordnete und ungeordnete Listen möglich.
Geordnete Listen
Zahlen mit Punkt vor jeder Zeile. Die Liste sollte mit 1 beginnen.
2. Second item
3. Third item
4. Fourth item
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
<li>Fourth item</li>
</ol>
- First item
- Second item
- Third item
- Fourth item
Ungeordnete Listen
Zeilen mit -, * oder + beginnen.
- Second item
- Third item
- Fourth item
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
<li>Fourth item</li>
</ul>
- First item
- Second item
- Third item
- Fourth item
Code
Wort oder Phrase in Backticks (`) setzen.
At the command prompt, type nano.
Codeblöcke
Jede Zeile mindestens vier Leerzeichen oder ein Tab einrücken, oder ``` vor und nach dem Block.
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}Trennlinien
Drei oder mehr ***, --- oder ___ in einer eigenen Zeile.
Links
Linktext in [ ], gefolgt von der URL in ( ), z. B. [Duck Duck Go](https://duckduckgo.com).
My favorite search engine is Duck Duck Go.
Titel für Links
Optional einen Titel in Anführungszeichen nach der URL – erscheint als Tooltip.
My favorite search engine is Duck Duck Go.
Bilder
! gefolgt von [Alt-Text] und (URL bzw. Pfad). Optional Titel in Anführungszeichen.
Escaping
Backslash vor Zeichen, die sonst als Formatierung gelten, um sie literal zu nutzen.
* Without the backslash, this would be a bullet in an unordered list.
Escapbare Zeichen
Backslash zum Escapen z. B. von:
| \ | backslash |
| ` | backtick |
| * | asterisk |
| _ | underscore |
| { } | curly braces |
| [ ] | brackets |
| ( ) | parentheses |
| # | pound sign |
| + | plus sign |
| - | minus sign (hyphen) |
| . | dot |
| ! | exclamation mark |
| | | pipe |
Tabellen
Mit --- die Kopfzeile pro Spalte erzeugen, mit | Spalten trennen.
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
Ausrichtung
Mit : links, rechts oder beidseitig der --- in der Kopfzeile ausrichten.
| :--- | :---: | ---: |
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |
| Links | Mitte | Rechts |
|---|---|---|
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |