Markdown ist eine einfache Auszeichnungssprache für strukturierten Text. Formatierungen werden direkt mit leicht lesbaren Zeichen im Text geschrieben und können später von geeigneten Programmen dargestellt oder weiterverarbeitet werden.

Markdown nutze ich vor allem dann, wenn Inhalte einfach, übersichtlich und langfristig lesbar dokumentiert werden sollen.

Typische Einsatzbereiche sind:

• Projektdokumentationen
• Arbeitsprotokolle
• technische Notizen
• Anleitungen
• Zusammenfassungen
• Festlegungen und Entscheidungen

Überschriften strukturieren ein Markdown-Dokument. Sie werden mit dem Zeichen # gekennzeichnet.

# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4

Markdown bietet einfache Möglichkeiten, Text hervorzuheben.

**fett**
*kursiv*
***fett und kursiv***

Markdown unterstützt ungeordnete und nummerierte Listen.

- Erster Punkt
- Zweiter Punkt
- Dritter Punkt

1. Erster Schritt
2. Zweiter Schritt
3. Dritter Schritt

Links werden in Markdown aus dem sichtbaren Linktext und der Zieladresse aufgebaut.

[OpenAI](https://openai.com)

Die allgemeine Schreibweise lautet:

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

Bilder werden in Markdown ähnlich wie Links eingebunden. Vor der eckigen Klammer steht zusätzlich ein Ausrufezeichen.

![Alternativtext](bilder/mein-bild.jpg)

Ein Bild aus dem Internet kann über seine Adresse eingebunden werden:

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

Kurze Codebestandteile können innerhalb eines normalen Textes mit einfachen Backticks gekennzeichnet werden.

Der Befehl `git status` zeigt den aktuellen Git-Status.

Für längere Codeblöcke werden drei Backticks verwendet.

```php
<?php
echo "Hallo Welt";
?>

Zitate werden in Markdown mit dem Zeichen > am Zeilenanfang gekennzeichnet.

> Das ist ein Zitat.

Auch mehrzeilige Zitate sind möglich:

> Dokumentation hilft nicht nur heute.
>
> Sie hilft vor allem dann, wenn man sich später fragt:
> „Wie hatte ich das damals eigentlich gemacht?“

Tabellen lassen sich in Markdown mit senkrechten Strichen | und einer Trennzeile für die Überschriften erstellen.

| Bereich | Verwendung |
| --- | --- |
| Dokumentation | Wissen festhalten |
| Arbeitsprotokoll | Arbeitsschritte dokumentieren |
| Anleitung | Vorgehensweisen beschreiben |

Eine horizontale Trennlinie kann in Markdown mit drei oder mehr Bindestrichen erzeugt werden.

---

Sie eignet sich dazu, größere Inhaltsbereiche optisch voneinander zu trennen.

Markdown-Dateien verwende ich mit der Dateiendung:

.md

Beispiel:

20260810_0309_Markdown_Dokumentation_V1.0.md

Für neu erstellte Dokumentationsdateien verwende ich grundsätzlich ein einheitliches Schema:

yyyymmdd_hhmm_beschreibung

Dabei bedeuten:

• yyyy – Jahr
• mm – Monat
• dd – Tag
• hh – Stunde
• mm – Minute
• beschreibung – kurze, sprechende Beschreibung des Inhalts

Beispiel:

20260810_0309_Markdown_Dokumentation_V1.0.md

Durch das vorangestellte Datum und die Uhrzeit werden die Dateien bereits über ihren Namen chronologisch sortiert.

Markdown-Dateien sind reine Textdateien und können mit unterschiedlichen Texteditoren bearbeitet werden.

Für meine Arbeit verwende ich hauptsächlich:

• Notepad++ – für schnelle und unkomplizierte Bearbeitung
• Visual Studio Code – insbesondere für Entwicklungsprojekte und umfangreichere Dokumentationen

Da Markdown ein reines Textformat ist, bleiben die Dateien unabhängig von einem bestimmten Programm lesbar und bearbeitbar.

Markdown verwende ich vor allem für Inhalte, bei denen der Text und seine Struktur wichtiger sind als eine aufwendige Seitengestaltung.

Typische Einsatzbereiche sind:

• Projektdokumentationen
• technische Dokumentationen
• Arbeitsprotokolle
• Anleitungen und Schritt-für-Schritt-Beschreibungen
• Festlegungen und Entscheidungen
• Zusammenfassungen
• Notizen und Wissenssammlungen
• README-Dateien in Entwicklungsprojekten

Markdown eignet sich für diese Aufgaben besonders gut, weil die Dateien einfach aufgebaut, schnell bearbeitet und langfristig auch ohne spezielle Software lesbar sind.

Die wichtigsten Markdown-Auszeichnungen auf einen Blick:

Diese Seite ist als persönliche Markdown-Kurzreferenz gedacht und wird bei Bedarf erweitert.

Neue Markdown-Funktionen oder Beispiele werden ergänzt, wenn sie in der praktischen Arbeit tatsächlich benötigt werden.