Anhang: Markdown Kernwissen

Dieser Anhang dient als schnelle Referenz für Markdown-Syntax und -Werkzeuge.

A.1 Schnellreferenz (Cheat Sheet)

Überschriften

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

Textformatierung

Markdown	Ergebnis
**fett**	fett
*kursiv*	kursiv
***fett und kursiv***	fett und kursiv
~~durchgestrichen~~	durchgestrichen

Listen

Ungeordnet:

- Punkt 1
- Punkt 2
  - Unterpunkt 2.1

Geordnet:

1. Erster
2. Zweiter

Links und Bilder

[Link](url)
![Bild](bild.jpg)

Code

Inline: `code`Block: `````` umschließt Code

Zitate

> Das ist ein Zitat

Horizontaler Trenner

---

Tabellen

| Spalte 1 | Spalte 2 |
|-----------|-----------|
| Zelle 1  | Zelle 2  |

Aufgabenlisten

- [x] Erledigt
- [ ] Offen

A.2 Markdown-Dialekte

Standard Markdown

Die ursprüngliche Spezifikation von John Gruber (2004).

CommonMark

Ein Versuch, Markdown zu standardisieren.

GitHub Flavored Markdown (GFM)

Erweiterungen von GitHub:

• Durchgestrichener Text
• Aufgabenlisten
• Tabellen
• Automatische Links

Pandoc Markdown

Pandoc-spezifische Erweiterungen:

• Fußnoten
• Zitationen
• Mathematik

A.3 Wichtige Tools

Editoren

Tool	Typ	Kosten	Besonderheit
VS Code	Desktop	Kostenlos	Viele Erweiterungen
Typora	Desktop	Kostenpflichtig	WYSIWYG
Obsidian	Desktop	Kostenlos (Persönlich)	Wissensmanagement
StackEdit	Online	Kostenlos	Synchronisation
HackMD	Online	Freemium	Kollaborativ

Konverter

Tool	Zweck
Pandoc	Konvertierung zwischen Formaten
Markdown CLI	Markdown → HTML
Grip	Lokale GitHub-ähnliche Vorschau

Static Site Generators

Tool	Sprache
Jekyll	Ruby
Hugo	Go
VitePress	JavaScript
Gatsby	JavaScript

A.4 Nützliche Ressourcen

Offizielle Dokumentation

• CommonMark Spec
• GitHub GFM Guide
• Pandoc User's Guide

Tutorials

• Markdown Tutorial
• CommonMark Tutorial
• GitHub Skills

Cheat Sheets

• Markdown Cheat Sheet (GitHub)
• Pandoc Cheat Sheet

A.5 Häufige Probleme und Lösungen

Problem 1: Überschrift wird nicht erkannt

Ursache: Fehlendes Leerzeichen nach #. Lösung: # Überschrift (mit Leerzeichen).

Problem 2: Liste wird nicht richtig angezeigt

Ursache: Falsche Einrückung. Lösung: 2 oder 4 Leerzeichen für Unterpunkte.

Problem 3: Bild wird nicht angezeigt

Ursache: Falscher Dateipfad oder Groß-/Kleinschreibung. Lösung: Überprüfen Sie den Pfad und die Dateinamenschreibung.

Problem 4: Link funktioniert nicht

Ursache: Fehlende Klammern oder falsche URL. Lösung: Überprüfen Sie die Syntax: [Text](url).

A.6 Markdown in verschiedenen Umgebungen

GitHub

• GFM ist Standard
• README.md wird automatisch gerendert
• Issue-Kommentare unterstützen GFM

GitLab

• Ähnlich wie GitHub
• Unterstützt GFM
• .gitlab-ci.yml für CI/CD

Slack

• *fett*, _kursiv_, ~durchgestrichen~
• Code mit `code`
• Block-Code mit ``````

Discord

• **fett**, *kursiv*, __unterstrichen__
• `code`
• ||spoiler||

A.7 Tastenkürzel (VS Code)

Aktion	Windows/Linux	Mac
Vorschau	Strg + Umschalt + V	Cmd + Umschalt + V
Fett	Strg + B	Cmd + B
Kursiv	Strg + I	Cmd + I
Inline-Code	`Strg + Umschalt + ``	`Cmd + Umschalt + ``

A.8 Checkliste für Markdown-Dokumente

• [ ] Groß-/Kleinschreibung bei Dateinamen konsistent?
• [ ] Leerzeilen zwischen Absätzen?
• [ ] Alt-Texte für Bilder vorhanden?
• [ ] Links funktionieren?
• [ ] Überschriften-Hierarchie eingehalten?
• [ ] Code-Blöcke mit Sprachangabe?
• [ ] Rechtschreibung geprüft?
• [ ] Bilder optimiert?

A.9 Weiterführende Themen

• LaTeX in Markdown: Mathematische Formeln
• Mermaid-Diagramme: Flussdiagramme, Sequenzdiagramme
• Front Matter: Metadaten für SSGs
• CSS-Styling: Benutzerdefinierte Styles

---

Viel Erfolg bei Ihren Markdown-Projekten! 🚀