Was ist Markdown und wie verwendet man es?

Markdown ist eine leichtgewichtige Auszeichnungssprache, mit der Sie formatierten Text mithilfe eines einfachen Texteditors erstellen können. Ursprünglich im Jahr 2004 von John Gruber erstellt, wird Markdown häufig für Dokumentation, Bloggen, Notizen und sogar zur Inhaltsformatierung in Websites und Anwendungen verwendet.

In diesem Artikel werden wir behandeln, was Markdown ist, wo es häufig verwendet wird und wie Sie seine wichtigsten Formatierungsfunktionen anwenden können.

Was ist Markdown?

Markdown ist eine einfache Möglichkeit, Text im Web zu gestalten. Anstatt komplexe HTML-Tags oder WYSIWYG-Editoren zu verwenden, ermöglicht Markdown Benutzern das Schreiben mit einer lesbaren Klartextsyntax, die dann in HTML konvertiert wird.

Um beispielsweise Text fett zu machen, umschließen Sie ihn einfach mit doppelten Sternchen wie **dies**, und um eine Liste zu erstellen, können Sie Bindestriche oder Zahlen verwenden.

Markdown ist beliebt für seine Ausgewogenheit zwischen Einfachheit und Flexibilität, wodurch es sowohl für technische als auch für nicht-technische Benutzer zugänglich ist.

Häufige Anwendungsfälle von Markdown

Markdown wird an vielen Stellen verwendet, an denen Klartext formatiert oder strukturiert werden muss.

Technische Dokumentation

Entwickler und technische Redakteure verwenden Markdown oft zum Schreiben von Dokumentationen, da es lesbar ist und sich leicht in Versionskontrollsysteme wie Git integrieren lässt.

README-Dateien in GitHub

GitHub unterstützt Markdown nativ für README-Dateien und Dokumentationen. Es ist das Standardformat, um ein Projekt vorzustellen und zu erklären.

Bloggen und Content Writing

Viele moderne statische Site-Generatoren wie Jekyll, Hugo und Next.js unterstützen Markdown für die Inhaltserstellung. Es wird auch von Blogging-Plattformen wie Ghost und Dev.to verwendet.

Notizen-Apps

Apps wie Obsidian, Notion (teilweise Unterstützung) und Bear ermöglichen es Benutzern, Notizen mit Markdown-Syntax zu schreiben, um die Formatierung zu vereinfachen.

E-Mail-Formatierung und Messaging

Einige E-Mail-Clients und Messaging-Plattformen (wie Slack und Discord) erlauben eine teilweise Markdown-Syntax für grundlegende Formatierungen wie fett, kursiv oder Codeblöcke.

Grundlegende Markdown-Syntax und ihre Verwendung

Die Markdown-Syntax ist einfach und menschenlesbar. Hier sind die häufigsten Elemente, die Sie benötigen.

Überschriften

Verwenden Sie #-Symbole, um Überschriften zu erstellen. Die Anzahl der #-Symbole entspricht der Überschriftenebene.

# H1 - Haupttitel
## H2 - Abschnittstitel
### H3 - Unterabschnittstitel

Hervorhebung

Sie können Text mit Kursiv- oder Fettschrift hervorheben:

*Kursiver Text* oder _Kursiver Text_
**Fetter Text** oder __Fetter Text__
***Fett und kursiv*** oder ___Fett und kursiv___

Listen

Markdown unterstützt sowohl ungeordnete als auch geordnete Listen.

  • Ungeordnete Liste:

    - Element 1
- Element 2
  - Unterelement

  • Geordnete Liste:

    1. Erstes Element
2. Zweites Element
   1. Verschachteltes Element

Links

Um einen Hyperlink hinzuzufügen, verwenden Sie eckige Klammern für den Text und runde Klammern für die URL:

[Besuchen Sie OpenAI](https://www.openai.com)

Bilder

Bilder verwenden die gleiche Syntax wie Links, beginnen aber mit einem Ausrufezeichen:

![Alternativtext](https://example.com/image.png)

Blockzitate

Um ein Blockzitat zu erstellen, stellen Sie der Zeile > voran:

> Dies ist ein Blockzitat.

Code und Codeblöcke

Für Inline-Code umschließen Sie den Text mit Graviszeichen:

Verwenden Sie die Funktion `console.log()`.

Für mehrzeilige Codeblöcke verwenden Sie dreifache Graviszeichen:

```javascript
function greet(name) {
  return `Hallo, ${name}`;
}
```

Horizontale Linie

Verwenden Sie drei oder mehr Bindestriche, Sternchen oder Unterstriche, um eine horizontale Linie zu erstellen:

---

Tabellen

Markdown-Tabellen verwenden Pipes und Bindestriche:

| Syntax | Beschreibung |
|--------|-------------|
| Kopfzeile | Titel |
| Zelle | Inhalt |

Tipps zum Schreiben in Markdown

  • Verwende ein Markdown-Vorschau-Tool (wie VS Code, Typora oder StackEdit), um die Ausgabe sofort anzuzeigen.
  • Wenn du längere Dokumente schreibst, organisiere deine Abschnitte mit passenden Überschriften.
  • Verwende eine konsistente Formatierung, um die Übersichtlichkeit zu gewährleisten.
  • Verwende Kommentare (im HTML-Stil <!-- Kommentar -->), um Notizen zu hinterlassen, die nicht in der endgültigen Ausgabe erscheinen.