6  Markdown

Markdown ist eine einfache Auszeichnungssprache (d.h. ein System zur Formatierung von Text), die entwickelt wurde, um leicht in HTML umgewandelt zu werden. Aufgrund ihrer Einfachheit und Vielseitigkeit wird sie häufig verwendet und eignet sich sehr gut für Dokumentationen, Berichte und die Aufzeichnung von Forschungsergebnissen.

In der Datenwissenschaft findet Markdown breite Anwendung. Wir nutzen es nicht nur zur Dokumentation von Projekten, sondern auch zur Erstellung dynamischer Berichte. Diese Berichte verbinden nahtlos erklärenden Text mit den Ergebnissen von Datenanalysen, oft mithilfe von Werkzeugen wie Jupyter Notebooks.

6.1 Markdown in Jupyter Notebook

Um mit Markdown in Jupyter Notebook zu beginnen, folgen wir diesen Schritten:

  1. Wir erstellen ein neues Jupyter-Notebook, wie zuvor in diesem Leitfaden zu Jupyter Notebook starten.

  2. Wir benennen unser Notebook hello-markdown.ipynb und speichern es im Ordner code:

    • Dazu navigieren wir zu “File > Save As…” und geben den Namen hello-markdown ein.

  3. Auf die erste Zelle klicken, so dass diese am linken Rand blau markiert erscheint.

    Abbildung 6.1: Markierte Zelle in Jupyter Notebook

  4. Wir ändern den Zelltyp der ersten Zelle mithilfe des Dropdown-Menüs in der Symbolleiste auf “Markdown”.

    Abbildung 6.2: Markdown in Dropdown-Menü auswählen

  5. Nun kann Text in diese Zelle eingegeben werden. In diesem Beispiel fügen wir eine Überschrift in die Zelle ein. Dies wird in Markdown mit der Auszeichnung # erzielt.

    # Dies ist eine Überschrift
    Abbildung 6.3: Markdown-Überschrift in Jupyter Notebook

  6. Um den Markdown-Text zu rendern (d.h. in HTML umzuwandeln), führen wir die markierte Zelle mit Shift+Eingabetaste aus oder nutzen den Run-Button (die Zelle muss dafür blau markiert sein). Dies überführt den “rohen” Markdown-Text in eine HTML-Ausgabe:

    Abbildung 6.4: Markdown-Überschrift als HTML-Ausgabe in Jupyter Notebook

In dem folgenden Abschnitt behandelen wir einige nützliche Markdown-Formatierungsoptionen.

6.2 Markdown-Basics

6.2.1 Überschriften

Mit Überschriften strukturieren wir unser Dokument und schaffen eine Hierarchie der Abschnitte.

# Hauptüberschrift (H1)
## Unterüberschrift (H2)
### Kleinere Unterüberschrift (H3)

6.2.2 Listen

Listen helfen uns, Informationen klar und prägnant zu organisieren.

Geordnete Listen:

1. Erster Punkt
2. Zweiter Punkt
  1. Erster Punkt
  2. Zweiter Punkt

Ungeordnete Listen:

- Aufzählungspunkt A
- Aufzählungspunkt B
  • Aufzählungspunkt A
  • Aufzählungspunkt B

6.2.3 Hervorhebungen

Durch Hervorhebungen können wir wichtige Punkte betonen. Dafür können wir die Auszeichnung mit dem Symbol * oder alternativ mit _ vornehmen.

*Kursiv*  
**Fett**  

_Kursiv mit Unterstrichen_  
__Fett mit Unterstrichen__

Kursiv
Fett

Kursiv mit Unterstrichen
Fett mit Unterstrichen

6.2.4 Blockzitate

Blockzitate verwenden wir, um Quellen oder wichtige Informationen zu zitieren.

> "Dies ist ein Blockzitat."

“Dies ist ein Blockzitat.”

6.2.5 Tabellen

Tabellen sind entscheidend für die effiziente Organisation von Daten.

| Spalte 1 | Spalte 2 |
|----------|----------|
| Zeile 1  | Wert 1   |
Spalte 1 Spalte 2
Zeile 1 Wert 1

Im Internet finden sich zahlreiche Tools, um einfach Markdown-Tabellen erstellen zu können (bspw. Table to Markdown)

6.2.7 Mathematische Ausdrücke

Durch die Integration von LaTeX können wir komplexe mathematische Formeln darstellen.

Inline-Gleichung:

$E = mc^2$

\(E = mc^2\)

Block-Gleichung:

$$
\frac{a}{b} + \sqrt{x}
$$

\[ \frac{a}{b} + \sqrt{x} \]

6.2.8 Horizontale Linien

Horizontale Linien helfen uns, Abschnitte visuell zu trennen.

---

6.2.9 Code-Blöcke

Mit Code-Blöcken präsentieren wir Code-Snippets und nutzen dabei Syntax-Hervorhebung.

```python
print("Hallo, Python!")
```
print("Hallo, Python!")

6.2.10 Weiterführendes Lernen

Um das Verständnis von Markdown weiter zu vertiefen, können diese Ressourcen genutzt werden:

6.3 Praktische Übung

Als nächstes werden wir das Gelernte in einer kleinen Übung anwenden:

  1. Neues Jupyter Notebook öffnen.

  2. Markdown-Zelle erstellen folgenden Text einfügen:

    # Markdown-Dokument

Hier ist eine Liste meiner Datenwissenschafts-Tools:

1. Python
2. Jupyter Notebooks
3. Pandas

Hier ist ein **wichtiger** Punkt zu beachten:

> Üben ist der Schlüssel zum Erfolg!

Dies ist als Python-Code formatierter Text innerhalb einer Markdown-Zelle (und kann deswegen nicht ausgeführt werden):

```python
print("Hallo, Python!")
```

  3. Zelle ausführen.