Markdown in 5 Minuten erklärt

Sie haben wahrscheinlich Markdown benutzt, ohne es zu wissen. Haben Sie schon mal **fett** in einer Slack-Nachricht getippt? Eine README auf GitHub geschrieben? Einen Reddit-Post formatiert? Das ist Markdown.

Markdown ist eine leichtgewichtige Art, reinen Text mit einfachen Symbolen zu formatieren. Statt Toolbar-Buttons für Fett, Kursiv, Überschriften und Listen zu klicken, tippen Sie einige wenige Zeichen, die die gewünschte Formatierung angeben. Es wurde 2004 von John Gruber und Aaron Swartz entwickelt und ist seitdem zur Standard-Formatierungssprache für Entwickler, Autoren und alle geworden, die im Web mit Text arbeiten.

Warum Markdown existiert

Vor Markdown bedeutete das Formatieren von Text für das Web, HTML zu schreiben. Um ein Wort fett zu machen, tippte man <strong>fett</strong>. Um eine Liste zu erstellen, brauchte man <ul><li>Element</li></ul>. HTML ist mächtig, aber umständlich und in Rohform schwer zu lesen.

Markdown löst das, indem es eine menschenlesbare Kurzschrift bietet. Der Rohtext ist auch vor dem Rendern leicht zu lesen. Die formatierte Ausgabe ist sauber und professionell. Man bekommt das Beste aus beiden Welten: lesbaren Quelltext und polierte Ausgabe.

Die wesentliche Syntax

Hier ist alles, was Sie wissen müssen, um Markdown produktiv einzusetzen.

Überschriften

Verwenden Sie Rautezeichen (#), um Überschriften zu erstellen. Mehr Rauten bedeuten kleinere Überschriften.

# Überschrift 1 (größte)
## Überschrift 2
### Überschrift 3
#### Überschrift 4

Fett und Kursiv

Umschließen Sie Text mit Sternchen oder Unterstrichen:

**fetter Text**
*kursiver Text*
***fett und kursiv***

Listen

Ungeordnete Listen verwenden Bindestriche, Sternchen oder Pluszeichen. Geordnete Listen verwenden Zahlen.

- Erster Punkt
- Zweiter Punkt
- Dritter Punkt

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

Links

Eckige Klammern für den Text, runde Klammern für die URL:

[Hier klicken](https://example.com)

Bilder

Wie Links, aber mit einem Ausrufezeichen davor:

![Alt-Text](bild-url.jpg)

Blockzitate

Verwenden Sie ein Größer-als-Zeichen:

> Dies ist ein Zitat. Es wird eingerückt und anders gestaltet dargestellt.

Code

Backticks für Inline-Code, dreifache Backticks für Codeblöcke:

Verwenden Sie die `print()`-Funktion zur Textausgabe.

Für mehrzeilige Codeblöcke verwenden Sie dreifache Backticks mit optionaler Sprachkennung:

```python
def hello():
    print("Hello, world!")
```

Horizontale Linien

Drei oder mehr Bindestriche, Sternchen oder Unterstriche:

---

Tabellen

Verwenden Sie Pipes und Bindestriche:

| Name | Rolle | Standort |
| --- | --- | --- |
| Alice | Entwicklerin | Berlin |
| Bob | Designer | London |

Wo Markdown verwendet wird

Markdown ist überall:

Softwareentwicklung

• GitHub, GitLab, Bitbucket: READMEs, Issues, Pull Requests und Dokumentation werden alle in Markdown geschrieben.
• Stack Overflow: Fragen und Antworten verwenden Markdown-Formatierung.
• Code-Dokumentation: Viele Dokumentationsgeneratoren (Docusaurus, MkDocs, Jekyll) verwenden Markdown als Quellformat.

Kommunikation

• Slack: Unterstützt eine Teilmenge von Markdown für die Nachrichtenformatierung.
• Discord: Verwendet Markdown für Fett, Kursiv, Codeblöcke und mehr.
• Reddit: Posts und Kommentare werden mit Markdown formatiert.

Schreiben und Veröffentlichen

• Blogs: Viele statische Seitengeneratoren verwenden Markdown-Dateien als Inhaltsquellen.
• Bücher: Mehrere Veröffentlichungstools akzeptieren Markdown-Manuskripte.
• Notizen: Apps wie Obsidian, Notion, Bear und Typora basieren auf Markdown.

Dokumentation

• Technische Docs: API-Dokumentation, Benutzerhandbücher und Wikis verwenden häufig Markdown.
• Interne Wissensbasen: Viele Teams nutzen Markdown-basierte Wikis.

Markdown-Varianten

Eine Sache, die man wissen sollte: Es gibt verschiedene „Varianten" von Markdown. Die Kernsyntax ist überall gleich, aber einige Plattformen fügen Erweiterungen hinzu:

Die Unterschiede liegen hauptsächlich in fortgeschrittenen Funktionen. Die Grundlagen (Überschriften, Fett, Kursiv, Listen, Links, Bilder, Code) funktionieren überall gleich.

Häufige Fehler

Leerzeilen vergessen

Markdown erfordert eine Leerzeile vor und nach vielen Elementen. Eine Überschrift braucht eine Leerzeile davor. Eine Liste braucht eine Leerzeile davor und danach. Das Vergessen dieser Leerzeilen ist die häufigste Ursache für Darstellungsprobleme.

Inkonsistente Listenzeichen

Das Mischen von -, * und + in derselben Liste kann zu unerwarteter Darstellung führen. Wählen Sie eines und bleiben Sie dabei.

Leerzeichen nach Symbolen

Einige Markdown-Prozessoren erfordern ein Leerzeichen nach dem # in Überschriften und nach - in Listen. Fügen Sie das Leerzeichen sicherheitshalber immer ein.

# Korrekte Überschrift
#Falsche Überschrift

- Korrekter Listenpunkt
-Falscher Listenpunkt

Warum sich Markdown zu lernen lohnt

Markdown lernt man in fünf Minuten und es spart über die Zeit Stunden. Wenn Sie es können, können Sie:

• Dokumentation schreiben, die auf GitHub wunderschön gerendert wird
• Nachrichten in Slack und Discord formatieren, ohne die Maus zu berühren
• Strukturierte Notizen machen, die zwischen Apps portabel sind
• Blogposts und Webinhalte aus reinen Textdateien erstellen
• An textbasierten Dokumenten zusammenarbeiten, ohne Formatkompatibilitätsprobleme

Das Verhältnis von Aufwand zu Nutzen ist eines der besten in der gesamten Tech-Welt.

Jetzt in Markdown schreiben:

• Markdown schreiben und Vorschau sehen
• Markdown-Vorschau-Tool

Kostenlos, in Ihrem Browser, mit Echtzeit-Vorschau beim Tippen.