Kapitel 13: Häufige Fehler und Best Practices

In diesem Kapitel lernen Sie, wie Sie häufige Fehler vermeiden und Markdown professionell nutzen.

13.1 Häufige Fehler

Fehler 1: Leerzeichen vergessen

Falsch:

#Überschrift
**[Fetter Text]**Text**

Richtig:

# Überschrift
**[Fetter Text]** Text**

Fehler 2: Falsche Listen-Einrückung

Falsch:

- Punkt 1
  - Unterpunkt 1.1

Richtig (2 oder 4 Leerzeichen):

- Punkt 1
  - Unterpunkt 1.1

Fehler 3: Bilder oder Links falsch

Falsch:

![Bild(bild.jpg)
[Link](https://example.com)

Richtig:

![Bild](bild.jpg)
[Link](https://example.com)

Fehler 4: Code-Blöcke falsch abschließen

Falsch:

```python
def hallo():
    print("Hallo")

Richtig:

```python
def hallo():
    print("Hallo")
```
````

## 13.2 Best Practices

### 1. Konsistente Formatierung

Entscheiden Sie sich für einen Stil und bleiben Sie dabei:

**Beispiel**:
```markdown
# Entweder so für Listen
- Punkt 1
- Punkt 2

# Oder so, aber nicht mischen
* Punkt 1
* Punkt 2
```

### 2. Leerzeilen verwenden

Verwenden Sie Leerzeilen zwischen Absätzen und Abschnitten:

```markdown
# Überschrift 1

Das ist ein Absatz.

Das ist ein neuer Absatz.

## Überschrift 2

Neuer Abschnitt.
```

### 3. Bilder optimieren

- Verwenden Sie beschreibende Alt-Texte: `![Ein Hund im Park](hund.jpg)`
- Komprimieren Sie Bilder vor dem Hochladen
- Verwenden Sie relative Pfade: `![Bild](./bilder/bild.jpg)`

### 4. Links sorgfältig setzen

- Verwenden Sie beschreibende Linktexte: `[Klicken Sie hier](url)` → `[Lesen Sie die Dokumentation](url)`
- Überprüfen Sie tote Links regelmäßig

### 5. Lesbarkeit im Quellcode

Denken Sie daran, dass Markdown auch im Quellcode lesbar sein soll:

**Schlecht**:
```markdown
#Überschrift1##Überschrift2###Überschrift3
```

**Gut**:
```markdown
# Überschrift 1

## Überschrift 2

### Überschrift 3
```

## 13.3 Barrierefreiheit (Accessibility)

### Alt-Texte für Bilder

**Schlecht**:
```markdown
![](bild.jpg)
```

**Gut**:
```markdown
![Eine rote Rose im Garten](rose.jpg)
```

### Überschriften-Hierarchie

**Schlecht** (springt von H1 zu H3):
```markdown
# Titel
### Untertitel
```

**Gut**:
```markdown
# Titel
## Untertitel
### Detail
```

### Listen für Inhalte verwenden

Verwenden Sie Listen für zusammengehörige Punkte, nicht nur Absätze.

## 13.4 Zusammenarbeit (Kollaboration)

### Konsistente Werkzeuge

Einigen Sie sich im Team auf:
- Einen Markdown-Dialekt (z.B. GFM)
- Einen Editor (z.B. VS Code)
- Formatierungsregeln

### Linter verwenden

Verwenden Sie **Markdown Linter** (VS Code Erweiterung oder CLI):

```bash
npm install -g markdownlint-cli
markdownlint *.md
```

### Pull Request Checkliste

Wenn Sie Markdown-Dateien in einem Team bearbeiten:

- [ ] Keine TODOs mehr vorhanden?
- [ ] Bilder optimiert?
- [ ] Links funktionieren?
- [ ] Rechtschreibung geprüft?
- [ ] Konsistent formatiert?

## 13.5 Versionskontrolle mit Git

### .gitignore

Fügen Sie große Binärdateien zur `.gitignore` hinzu:

```gitignore
# Bilder nicht versionieren, wenn sie groß sind
*.png
*.jpg

# Oder nur bestimmte Ordner
bilder/roh/
```

### Git Hooks für Markdown

Verwenden Sie **Husky** für Git Hooks:

```bash
npm install husky --save-dev
npx husky install
```

Fügen Sie einen Pre-Commit-Hook hinzu:

```bash
npx husky add .husky/pre-commit "markdownlint *.md"
```

## 13.6 Zusammenfassung

In diesem Kapitel haben Sie gelernt:
- ✅ Häufige Fehler und wie man sie vermeidet
- ✅ Best Practices für sauberes Markdown
- ✅ Barrierefreiheit (Accessibility)
- ✅ Zusammenarbeit im Team
- ✅ Versionskontrolle mit Git

Im nächsten Kapitel werden wir Markdown für verschiedene Anwendungsbereiche (Akademisch, Technisch, Kreativ) anpassen!

---

**Übung**: Nehmen Sie eine Ihrer alten Markdown-Dateien und verbessern Sie sie basierend auf den Best Practices aus diesem Kapitel.