Markdown ist aus der modernen Softwareentwicklung nicht mehr wegzudenken. Ob in README-Dateien, GitHub-Issues, technischen Wikis oder modernen CMS-Systemen – die von John Gruber im Jahr 2004 entwickelte Sprache wandelt einfachen Text effizient in strukturiertes HTML um. Da Entwickler tagtäglich mit Dokumentation arbeiten, ist die Beherrschung dieser Auszeichnungssprache eine Grundvoraussetzung für sauberes, lesbares Arbeiten.

Grundlegende Syntax

Überschriften

Markdown Überschriften
# Überschrift 1 (H1 — Nur einmal pro Dokument verwenden)
## Überschrift 2 (H2 — Hauptabschnitte)
### Überschrift 3 (H3 — Untersektionen)
#### Überschrift 4 (H4 — Detaillierte Ebenen)

Textformatierung

Fett, Kursiv, Durchgestrichen
**fetter Text**
*kursiver Text*
***fett und kursiv***
~~durchgestrichen~~
`Inline-Code-Snippet`

Listen

Geordnete & Ungeordnete Listen
- Listenelement ohne Nummer
- Ein weiteres Element
  - Verschachteltes Element (2 Leerzeichen)
  - Noch ein Unterpunkt

1. Nummeriertes Element
2. Nummeriertes Element
3. Nummeriertes Element

- [x] Erledigte Aufgabe (GitHub Stil)
- [ ] Offene Aufgabe

Links & Bilder

Links & Bilder einbinden
[Link-Text](https://beispiel.de)
[Link mit Titel](https://beispiel.de "Titel beim Hovern")
![Alt-Text für Bild](https://beispiel.de/bild.png)


Hier klicken: [Dokumentation][docs]

[docs]: https://docs.beispiel.de

Code-Blöcke

Code-Blöcke und Syntax-Highlighting
Inline-Code: `const server = express();`

Fenced Code-Block mit Sprache:
```javascript
function willkommen(name) {
  console.log(`Hallo, ${name}!`);
}
```

```bash
npm install express
npm run dev
```

Tabellen

Markdown Tabellen
| Funktion   | Chrome | Firefox | Safari |
|------------|:------:|:-------:|:------:|
| WebP       | ✅     | ✅      | ✅     |
| AVIF       | ✅     | ✅      | ✅     |

Ausrichtung:
| Links | Mitte | Rechts |
|:------|:-----:|-------:|
| links | mitte | rechts |

Blockzitate

Zitate im Text
> Dies ist ein Blockzitat.
> Es kann sich über mehrere Zeilen erstrecken.
>
> — Autor

GitHub Flavored Markdown (GFM)

GitHub erweitert den Standard-Markdown-Satz um mächtige Funktionen:

  • Checklisten: - [x] Erledigt / - [ ] To-Do
  • URL-Autolinking: Einfaches Einfügen genügt für klickbare Links.
  • Emojis: :rocket: → 🚀, :check: → ✅
  • Alerts/Hinweise: > [!NOTE], > [!WARNING]
  • Syntax-Highlighting: Automatisierte Farberkennung durch Sprachzuweisung.
  • Fußnoten: Text[^1] mit [^1]: Fußnotentext.

Struktur einer professionellen README

README Vorlage
# Projektname

Kurze Zusammenfassung, was das Projekt leistet.

## Installation

```bash
npm install my-package
```

## Verwendung

```javascript
import { start } from 'my-package';
start();
```

## API Referenz

| Parameter | Typ | Standard | Beschreibung |
|-----------|-----|----------|--------------|
| `timeout` | int | 5000     | ms Dauer     |

## Mitwirken

1. Forke das Repo
2. Erstelle einen Branch
3. Commit deine Änderungen
4. Erstelle einen Pull Request

## Lizenz

MIT

Best Practices für Entwickler

  • Eine H1 pro Dokument — Nutze H2/H3 für eine saubere Hierarchie.
  • Leerzeilen einbauen — Sorge für Platz um Listen und Blöcke für bessere Lesbarkeit.
  • Referenz-Links nutzen — Hält URLs vom Fließtext fern.
  • Sprach-Tags verwenden — Hilft IDEs beim Highlighting.
  • Zeilenlänge begrenzen — Halte Absätze auf ca. 80-100 Zeichen.
  • Alt-Texte bei Bildern — Essenziell für Barrierefreiheit und SEO.

Entdecke unsere Entwickler-Tools

Optimiere deinen Workflow mit unseren kostenlosen Online-Tools.