Spickzettel - GitHub-Stil Markdown

2023-12-12

GitHub Flavored Markdown (GFM) erweitert die Standard Markdown-Syntax um einige zusätzliche Funktionen, die spezifisch für GitHub sind. Dieses Cheat Sheet behandelt die wichtigsten Aspekte von GFM und erleichtert die Erstellung von READMEs, Issues und anderer Dokumentation auf GitHub.

Erweiterte Syntax

Aufgabenlisten

Erstellen Sie Aufgabenlisten mit - [ ] für eine unvollständige Aufgabe und - [x] für eine abgeschlossene Aufgabe.
```
-   [x] Abgeschlossene Aufgabe
-   [ ] Unvollständige Aufgabe
```

Durchstreichungen

Verwenden Sie doppelte Tilden ~~, um Text durchzustreichen.
```
~~Durchstrichen~~
```

Tabellen

Erstellen Sie Tabellen mit Hilfe von Bindestrichen - und senkrechten Strichen |.

| Kopfzeile 1 | Kopfzeile 2 |
| -------- | -------- |
| Zeile 1    | Daten 1   |
| Zeile 2    | Daten 2   |

Abgetrennte Code-Blöcke

Verwenden Sie dreifache Backticks (```) und geben Sie eine Sprache für die Syntaxhervorhebung an.

```javascript console.log("Hallo, Welt!"); ```

Benutzer und Teams erwähnen

Verwenden Sie @benutzername, um einen Benutzer oder ein Team zu erwähnen.

Issue- und Pull Request-Referenzen

Referenzieren Sie Issues und Pull Requests mit #.

Standard Markdown-Syntax

Überschriften

Verwenden Sie # für Überschriften. Mehr #s bedeuten kleinere Überschriften.

Textformatierung

Fett: **fett**
Schräg: *schräg*
Fett und Schräg: ***fett & schräg***

Listen

Ungeordnete Liste: Beginnen Sie mit -, + oder *.
Geordnete Liste: Beginnen Sie mit Zahlen, gefolgt von ..

Links und Bilder

Link: [Titel](URL)
Bild: ![Alternativtext](URL)

Blockzitate

Verwenden Sie > für Blockzitate.

GitHubs Markdown ermöglicht interaktive und dynamische Dokumentationen, die insbesondere im Kontext von kollaborativen Projekten nützlich sind.