Markdown Syntax Cheatsheet

Markdown ist die Standard-Formatierung für Dokumentation. Einfach zu lernen, überall einsetzbar – von GitHub README bis Notion. Hier alle wichtigen Befehle.

Überschriften

# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4
##### Überschrift 5
###### Überschrift 6

Textformatierung

Listen

Ungeordnete Liste

- Punkt 1
- Punkt 2
  - Unterpunkt 2.1
  - Unterpunkt 2.2
- Punkt 3

* Auch mit Sternchen
+ Oder mit Plus

Geordnete Liste

1. Erster Punkt
2. Zweiter Punkt
3. Dritter Punkt
   1. Unterpunkt
   2. Unterpunkt

Checkliste (GitHub)

- [x] Erledigt
- [ ] Offen
- [ ] Noch zu tun

Links und Bilder

# Link
[Linktext](https://example.com)

# Link mit Titel
[Linktext](https://example.com "Titel beim Hover")

# Referenz-Link
[Linktext][ref]
[ref]: https://example.com

# Automatischer Link
<https://example.com>

# E-Mail
<email@example.com>

Bilder

# Bild
![Alt-Text](bild.jpg)

# Bild mit Titel
![Alt-Text](bild.jpg "Titel")

# Bild mit Link
[![Alt-Text](bild.jpg)](https://example.com)

Code

Inline-Code

Nutze `console.log()` zum Debuggen.

Code-Block

```javascript
function hello() {
    console.log("Hallo Welt");
}
```

```python
def hello():
    print("Hallo Welt")
```

```bash
npm install package
```

Zitate

> Dies ist ein Zitat.
>
> Es kann mehrere Absätze haben.

> Verschachtelte Zitate
>> Sind auch möglich

Tabellen

| Spalte 1 | Spalte 2 | Spalte 3 |
|----------|----------|----------|
| Zelle 1  | Zelle 2  | Zelle 3  |
| Zelle 4  | Zelle 5  | Zelle 6  |

# Ausrichtung
| Links    | Mitte    | Rechts   |
|:---------|:--------:|---------:|
| Text     | Text     | Text     |

Horizontale Linie

---
***
___

Escaping

\* Sternchen ohne Formatierung
\# Keine Überschrift
\[ Keine Links \]

Erweiterte Syntax (GitHub)

Fußnoten

Text mit Fußnote[^1].

[^1]: Dies ist die Fußnote.

Definition Lists

Begriff
: Definition des Begriffs

Alerts (GitHub)

> [!NOTE]
> Nützliche Information

> [!TIP]
> Hilfreicher Tipp

> [!IMPORTANT]
> Wichtige Information

> [!WARNING]
> Warnung

> [!CAUTION]
> Vorsicht

Collapsed Section

<details>
<summary>Klicken zum Aufklappen</summary>

Versteckter Inhalt hier.

</details>

README.md Best Practices

# Projektname

Kurze Beschreibung des Projekts.

## Installation

```bash
npm install paketname
```

## Verwendung

```javascript
const paket = require('paketname');
paket.doSomething();
```

## API

### `methode(param)`

Beschreibung der Methode.

**Parameter:**
- `param` (string): Beschreibung

**Rückgabe:** Beschreibung

## Lizenz

MIT

Markdown-Tools

• Typora: WYSIWYG Markdown Editor
• Obsidian: Notizen mit Markdown
• StackEdit: Online Markdown Editor
• Marked: Node.js Markdown Parser

Weitere Informationen

• 🔧 Git Grundlagen
• 🚀 GitHub Actions