Markdown: Die Grundlagen

Martin Post

Die wichtigsten Markdown-Elemente

Gelegentlich werden wir von Kunden und Geschäftspartnern nach Markdown gefragt. Daher finden Sie hier einen sehr grundlegenden Leitfaden zu dieser beliebten einfachen Auszeichnungssprache.

Bitte beachten Sie, dass es sich hierbei nur um ein einfaches Markdown-Referenzdokument handelt. Es gibt viele weitere ausführliche und detaillierte Quellen für Markdown, wie zum Beispiel …

1. Einfache Textabsätze

Ein Absatz erfordert überhaupt keine Formatierung.

Schreiben Sie einfach Ihren Inhalt und drücken Sie zwei Mal die Zeilenschalter-Taste. Sie können Zeilenumbrüche hinzufügen, sollten den Inhalt jedoch nicht einrücken.

Es ist besser, den Mund zu halten 
und die Leute vermuten zu lassen, man sei ein Dummkopf, 
als ihn zu öffnen und jeden Zweifel zu beseitigen.

Ergebnis:

Es ist besser, den Mund zu halten und die Leute vermuten zu lassen, man sei ein Dummkopf, als ihn zu öffnen und jeden Zweifel zu beseitigen.

2. Überschriften

Um Überschriften zu erstellen, verwenden Sie führende Hash-Zeichen, gefolgt von einem oder mehreren Leerzeichen – von „#“ für Ebene 1 bis „######“ für Ebene 6, etwa so:

## Demo: Dies ist ein Ebene-2-Überschrift

Hier sind einige Inhalte.

### Demo: Dies ist ein Ebene-3-Überschrift

Hier sind einige Inhalte.

### Demo: Dies ist ein Ebene-4-Überschrift

Hier sind einige Inhalte.

Ergebnis:

Demo: Dies ist ein Ebene-2-Überschrift

Hier sind einige Inhalte.

Demo: Dies ist ein Ebene-3-Überschrift

Hier sind einige Inhalte.

Demo: Dies ist ein Ebene-4-Überschrift

Hier sind einige Inhalte.

3. Verschiedene Inline-Textformatierungen Fettschrift, Kursivierung usw.

Verwenden Sie zur Hervorhebung Sternchen oder Unterstriche:

Hier ist ein Satz mit einigen *kursiv geschriebenen / hervorgehobenen* Wörtern.

Hier ist ein Satz mit **starker Betonung**: 
die normalerweise in __Fettschrift__ dargestellt wird.

Tiefgestellter und hochgestellter Text: 
H~2~O ist eine Flüssigkeit. 
und hier ist eine 100 m^2^ große Wohnung.

Ergebnis:

Hier ist ein Satz mit einigen kursiv geschriebenen / hervorgehobenen Wörtern.

Hier handelt es sich um einen Satz mit starker Betonung, die normalerweise in Fettschrift dargestellt wird.

Tiefgestellter und hochgestellter Text: H₂O ist eine Flüssigkeit, und hier ist eine 100 m²-Wohnung.

4. Listen

4.1 Einfache ungeordnete Listen

- Dies ist Listenpunkt 1 in dieser Liste
- Dies ist Listenpunkt 2 in dieser Liste \
  Dies ist Zeile 2 von Listenelement 2.

Ergebnis:

Dies ist Listenpunkt 1 in dieser Liste
Dies ist Listenpunkt 2 in dieser Liste
Dies ist Zeile 2 von Listenelement 2.

4.2 Verschachtelte ungeordnete Listen

Listenelemente zum Verschachteln einrücken:

- Dies ist Listenpunkt 1 in dieser Liste
- Dies ist Listenpunkt 2 in dieser Liste
  - Dies ist Listenpunkt 1 in dieser eingerückten Liste
  - Dies ist Listenpunkt 2 in dieser eingerückten Liste
- Dies ist Listenpunkt 3 in dieser Liste

Ergebnis:

Dies ist Listenpunkt 1 in dieser Liste
Dies ist Listenpunkt 2 in dieser Liste
- Dies ist Listenpunkt 1 in dieser eingerückten Liste
- Dies ist Listenpunkt 2 in dieser eingerückten Liste
Dies ist Listenpunkt 3 in dieser Liste

4.3 Einfache geordnete Listen

Es ist nicht erforderlich, Listen korrekt zu nummerieren, die Startnummer wird jedoch beachtet.

1. Dies ist Listenpunkt 1 in dieser Liste
1. Dies ist Listenpunkt 2 in dieser Liste

Ergebnis:

Dies ist Listenpunkt 1 in dieser Liste
Dies ist Listenpunkt 2 in dieser Liste

4.4 Verschachtelte geordnete Listen

Dies ist eine geordnete Liste, beginnend bei 2.
Dies ist Listenpunkt 2 in dieser Liste
1. Dies ist Listenpunkt 1 in dieser eingerückten Liste
2. Dies ist Listenpunkt 2 in dieser eingerückten Liste
Dies ist Listenpunkt 3 in dieser Liste

Ergebnis:

Dies ist eine geordnete Liste, beginnend bei 2.
Dies ist Listenpunkt 2 in dieser Liste
1. Dies ist Listenpunkt 1 in dieser eingerückten Liste
2. Dies ist Listenpunkt 2 in dieser eingerückten Liste
Dies ist Listenpunkt 3 in dieser Liste

5. Tabellen

Sie können Tabellen richtig ausrichten, indem Sie eine dicktengleiche Schriftart verwenden, bei der jedes Element ausgerichtet ist, etwa so:

Head Cell 1    Head Cell 2    Head Cell 3   
-------------- -------------- --------------
Row 1 Cell 1   Row 1 Cell 2   Row 1 Cell 3  
Row 2 Cell 1   Row 2 Cell 2   Row 2 Cell 3  
Sum 1          Sum 2          Sum 3         

: Bezeichnung Tabelle 1

Ergebnis:

Bezeichnung Tabelle 1
Head Cell 1 Hea	d Cell 2 Head C	ell 3
Row 1 Cell 1 Ro	w 1 Cell 2 Row	1 Cell 3
Row 2 Cell 1 Ro	w 2 Cell 2 Row	2 Cell 3
Sum 1 Sum 2 Sum	3

… oder Sie können einfach „schlampig“ sein und die notwendigen Trennzeichen („|“ und „-“) ohne Abstände verwenden, um einfache Pipe-Tabellen zu erzeugen:

Head Cell 1 | Head Cell 2 | Head Cell 3, which is longer than the others
--- | --- | ---
Row 1 Cell 1 | Row 1 Cell 2 | Row 1 Cell 3
Row 2 Cell 1, which is fairly long. | Row 2 Cell 2 | Row 2 Cell 3
Row 3 Cell 1 | Row 3 Cell 2 | Row 3 Cell 3
Sum 1 | Sum 2 | Sum 3

: Label für Tabelle 2

Bitte beachten Sie, dass dieser Tabellen-Notationsstil keine Absätze/Zeilenumbrüche innerhalb von Tabellenzellen zulässt.

Ergebnis:

Label für Tabelle 2
Head Cell 1	Head Cell 2	Head Cell 3, which is longer than the others
Row 1 Cell 1	Zeile 1 Zelle 2	Row 1 Cell 3
Row 2 Cell 1, which is fairly long.	Row 2 Cell 2	Zeile 2 Zelle 3
Zeile 3 Zelle 1	Zeile 3 Zelle 2	Row 3 Cell 3
Sum 1	Summe 2	Sum 3

5.1 Ausrichten von Tabellenspalten

Richten Sie die Inhalte der Tabellenspalten mithilfe von Doppelpunkten in der Trennlinie zwischen Kopf und Text aus:

Default| Left | Right | Center 
-------|:-----|------:|:------:
1      |  1   |  1    | 1
12     |  12  |  12   | 12
123    |  123 |  123  | 123

: Label für Tabelle 3

Ergebnis:

Label für Tabelle 3
Standard	Linksbündig	Rechtsbündig	Zentriert
1	1	1	1
12	12	12	12
123	123	123	123

6. Links

6.1 Automatische Links

Bitte senden Sie mir eine E-Mail an <mp@9to5.de>.

Weitere Informationen finden Sie unter https://de.wikipedia.org/wiki/Markdown.

Ergebnis:

Bitte senden Sie mir eine E-Mail an mp@9to5.de.

Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/.

6.2 Direkte Links

Ein Absatz [mit einem Inline-Link zu Google](https://google.com/).

Ergebnis:

Ein Absatz mit einem Inline-Link zu Google.

6.3 Referenzlinks

Referenzlinks sind ein wirkungsvolles Konzept, aber die Pflege dieser Links erfordert mehr Disziplin, da sich der Link (Text) und seine Definition an verschiedenen Stellen eines Dokuments befinden können.

Ein Link zur [Google-Startseite][GoogleHome].

Ein Link zum [englischen Wikipedia-Eintrag][GoogleWiki] über Google.

[GoogleHome]: https://google.com/
[GoogleWiki]: https://en.wikipedia.org/wiki/Google 
  {title="Additional information about this link"}

Ergebnis:

Ein Link zur Google-Startseite.

Ein Link zum englischen Wikipedia-Eintrag über Google.

6.4 Links innerhalb eines Dokuments

Ein direkter Link zu einem Abschnitt in diesem Dokument namens [6. Links].

Ergebnis:

Ein direkter Link zu einem Abschnitt in diesem Dokument namens [6. Links].

Wichtig: Nach dem Ändern des Titels funktioniert der Link nicht mehr.

7. Bilder

Um Bilder verwenden zu können, müssen Sie die (relativen oder absoluten) URLs (Adressen) dieser Bilder kennen und verwenden.

7.1 Lokal definierte Bilder

Ein Inline-Bild: ![Description](https://assets.specs-and-docs.online/images/9to5/image_small.png)

Ein Bild in einem eigenen Absatz, das bei Verwendung eines modernen Markdown-Konverters in eine Abbildung mit Beschriftung umgewandelt wird:

![Dies ist die Bildbeschreibung](https://assets.specs-and-docs.online/images/9to5/image.png)

Ergebnis:

Ein Inline-Bild: Beschreibung

Ein Bild in einem eigenen Absatz, das bei Verwendung eines modernen Markdown-Konverters in eine Abbildung mit Beschriftung umgewandelt wird:

7.2 Referenzierte Bilder

Referenzierte Bilder sind – ebenso wie Referenzlinks – ein leistungsstarkes Konzept, aber die Arbeit mit diesen Referenzbildern erfordert mehr Disziplin, da sich der Bildplatzhalter und seine Definition (mit der URL und zusätzlichen Informationen wie Breite und CSS-Klasse) an verschiedenen Stellen eines Dokuments befinden können.

Ein Bild in einem Absatz (referenziert): 
![Alternativer Text][testimage1] 
und Text direkt nach diesem Bild.

[testimage1]: https://assets.specs-and-docs.online/images/9to5/image_colored_small_extra.png

Ergebnis:

Ein Bild in einem Absatz (referenziert): Alternativer Text und Text direkt nach diesem Bild.

8. Fußnoten

Hier ist eine Fußnotenreferenz,[^1] und hier noch eine.[^longnote]

[^1]: Hier ist die eigentliche Fußnote. Der Fußnotentext folgt direkt im Quelldokument, sollte jedoch im erstellten Dokument am Ende des Dokuments angezeigt werden.

[^longnote]: Hier ist eine Fußnote mit mehreren Blöcken. Der Fußnotentext folgt direkt im Quelldokument, sollte jedoch im erstellten Dokument am Ende des Dokuments angezeigt werden.

    Nachfolgende Absätze werden eingerückt, um anzuzeigen, dass sie zur vorherigen Fußnote gehören.

Ergebnis:

Hier ist eine Fußnotenreferenz¹, und hier noch eine.²

9. Metadaten

In den meisten Markdown-Implementierungen können Sie Metadaten im YAML-Format am Anfang des Dokuments hinzufügen, etwa so:

---
title: "Titel des Dokuments"
document-date: "2024-12-31"
---

Ob und wie diese Metadatenfelder verarbeitet werden, hängt von Ihrem Markdown-Konverter, den verwendeten Zielformaten und Vorlagen ab.

Zurück zum Seitenanfang

Hier ist die eigentliche Fußnote. Der Fußnotentext folgt direkt im Quelldokument, sollte jedoch im erstellten Dokument am Ende des Dokuments angezeigt werden.↩︎
Hier ist eine Fußnote mit mehreren Blöcken. Der Fußnotentext folgt direkt im Quelldokument, sollte jedoch im erstellten Dokument am Ende des Dokuments angezeigt werden.

Nachfolgende Absätze werden eingerückt, um anzuzeigen, dass sie zur vorherigen Fußnote gehören.↩︎

↻ 2024-11-01