Kapitel 6: GitHub Flavored Markdown (GFM)

In diesem Kapitel lernen Sie die Erweiterungen von GitHub Flavored Markdown, die speziell für die Zusammenarbeit auf GitHub entwickelt wurden.

6.1 Was ist GitHub Flavored Markdown (GFM)?

GFM ist eine Erweiterung der Standard-Markdown-Syntax, die von GitHub populär gemacht wurde. Sie fügt nützliche Funktionen hinzu, die besonders für Software-Dokumentation und Zusammenarbeit nützlich sind.

Hauptmerkmale von GFM

• ✅ Durchgestrichener Text
• ✅ Aufgabenlisten (Task Lists)
• ✅ Automatische Verlinkung von URLs
• ✅ Emoji-Unterstützung
• ✅ Tabellen
• ✅ Syntaxhervorhebung

6.2 Durchgestrichener Text

~~Dieser Text ist durchgestrichen~~

Ergebnis: Dieser Text ist durchgestrichen

Anwendungsbeispiele:

• Fehlerkorrekturen: Die Antwort ist ~~42~~ 43.
• Veraltete Information: ~~Diese Funktion ist veraltet~~

6.3 Aufgabenlisten (Task Lists)

Aufgabenlisten sind besonders nützlich für Projektmanagement auf GitHub.

Grundlegende Syntax

- [x] Aufgabe 1 erledigt
- [ ] Aufgabe 2 offen
- [ ] Aufgabe 3 offen

Ergebnis (auf GitHub werden interaktive Checkboxen angezeigt):

• [x] Aufgabe 1 erledigt
• [ ] Aufgabe 2 offen
• [ ] Aufgabe 3 offen

Verschachtelte Aufgabenlisten

- [x] Projekt eingerichtet
  - [x] Repository erstellt
  - [ ] README geschrieben
  - [ ] Lizenz hinzugefügt
- [ ] Erste Version veröffentlicht

In GitHub Issues und Pull Requests

Aufgabenlisten in Issues oder Pull Requests werden besonders nützlich:

• Sie können direkt auf GitHub abgehakt werden
• Der Fortschritt wird in der Übersicht angezeigt

6.4 Automatische Verlinkung

GFM erkennt URLs automatisch, ohne dass Sie Klammern verwenden müssen:

Besuchen Sie https://www.github.com für mehr Informationen.

Ergebnis: Besuchen Sie https://www.github.com für mehr Informationen.

6.5 Emojis

GFM unterstützt Emojis mit Doppelpunkten:

:smile: :heart: :thumbsup: :rocket:

Ergebnis: 😄 ❤️ 👍 🚀

Beliebte Emojis für GitHub

Emoji-Code	Emoji	Verwendung
:white_check_mark:	✅	Erledigt
:x:	❌	Fehler
:warning:	⚠️	Warnung
:bulb:	💡	Idee
:bug:	🐛	Bug
:sparkles:	✨	Neue Funktion

6.6 Tabellen

GFM unterstützt Tabellen (wir haben dies bereits in Kapitel 3 behandelt).

| Name | Rolle | Beiträge |
|-------|-------|-----------|
| Anna | Entwicklerin | 42 |
| Ben | Designer | 17 |

6.7 Syntaxhervorhebung

GFM unterstützt Syntaxhervorhebung in Code-Blöcken:

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

6.8 Datei- und Commit-Referenzen

In GFM können Sie automatisch auf Dateien, Commits, Issues und Pull Requests verweisen.

Auf Issues verweisen

Fixes #42
Closes #123

Auf Commits verweisen

Behoben in a5c3d2f

Auf Benutzer verweisen

Danke an @username für den Beitrag!

6.9 Zitate (Blockquotes) für Unterhaltungen

GFM verwendet Zitate oft für Unterhaltungen:

> Das ist ein Zitat.

> Und eine Antwort darauf.

6.10 Inhaltsverzeichnis automatisch generieren

In GFM werden Überschriften automatisch verlinkt, aber Sie können manuell ein Inhaltsverzeichnis erstellen:

## Inhaltsverzeichnis

- [Einleitung](#einleitung)
- [Hauptteil](#hauptteil)
- [Fazit](#fazit)

6.11 GFM auf GitHub verwenden

README.md

Jedes GitHub-Repository sollte eine README.md haben. Dies ist die erste Datei, die Besucher sehen.

Beispiel für eine gute README:

# Projektname

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)

## Beschreibung
Kurze Beschreibung des Projekts.

## Installation
Schritte zur Installation.

## Nutzung
Beispiele zur Nutzung.

## Beitragen
Richtlinien für Beiträge.

## Lizenz
MIT

Pull Request Beschreibungen

Verwenden Sie GFM in Pull Request Beschreibungen:

• Verknüpfen Sie mit Issues: Closes #42
• Verwenden Sie Aufgabenlisten für PR-Checklisten
• Fügen Sie Screenshots mit ![Bild](url) hinzu

6.12 GFM in anderen Umgebungen

Viele andere Plattformen unterstützen GFM oder Teile davon:

• GitLab: Ähnliche Funktionen wie GitHub
• Bitbucket: Unterstützt GFM
• Notion: Unterstützt GFM-Syntax
• Slack: Unterstützt teilweise GFM

6.13 Zusammenfassung

In diesem Kapitel haben Sie gelernt:

• ✅ Was GitHub Flavored Markdown (GFM) ist
• ✅ Durchgestrichener Text und Aufgabenlisten
• ✅ Emojis und automatische Verlinkung
• ✅ Verweise auf Issues, Commits und Benutzer
• ✅ GFM in README.md und Pull Requests verwenden

Im nächsten Kapitel werden wir lernen, wie man Markdown in Kombination mit anderen Tools verwendet!

---

Übung: Erstellen Sie eine CONTRIBUTING.md Datei für ein fiktives Projekt mit:

1. Einer Aufgabenliste für Beitragsrichtlinien
2. Einem Emoji am Anfang
3. Einem Verweis auf eine Issue-Nummer
4. Einem Screenshot-Beispiel