Glossar

Markdown-Fachbegriffe

Von CommonMark bis Mermaid. Was die Begriffe hinter Markdown bedeuten und warum sie praktisch wichtig sind.

CommonMark

Kurz: Die formal standardisierte Markdown-Spezifikation, etabliert 2014.

CommonMark löst Mehrdeutigkeiten der Original-Markdown-Spec von 2004 und definiert eine eindeutige Test-Suite. Basis aller modernen Markdown-Renderer.

GFM

Kurz: GitHub-Flavored Markdown. CommonMark plus Tabellen, Task-Lists, Strikethrough, Autolinks, Footnoten.

GFM ist de-facto-Standard für Code-Hoster und viele Doku-Tools. Wer ein README für GitHub schreibt, nutzt GFM. GitLab, Bitbucket und viele andere haben GFM übernommen.

GLFM

Kurz: GitLab-Flavored Markdown. GFM plus Mermaid (vollständig), KaTeX-Math, Front-Matter, Quick-Actions.

GitLab erweitert GFM um wissenschaftliche und projekt-management-relevante Features. Mermaid funktioniert in Wikis und MR-Beschreibungen, nicht nur in Issues.

Pandoc

Kurz: Universelles Dokument-Konvertierungs-Tool. Markdown zu HTML, PDF, Docx, LaTeX, ePub und Dutzende andere Formate.

Pandoc ist Open-Source und CLI-basiert. Mit Citation-Syntax und BibTeX-Integration ist es Standard für wissenschaftliche Texte. Pandoc-Markdown ist eigener Dialekt mit maximalem Funktionsumfang.

Frontmatter

Kurz: Strukturierte Metadaten am Anfang einer Markdown-Datei, meist als YAML oder TOML zwischen "---"-Linien.

Wird von Static-Site-Generatoren (Hugo, Jekyll, Astro) als Datei-Metadaten genutzt: Title, Datum, Autor, Tags. Auch in GitLab-Wikis und Obsidian verwendet.

YAML

Kurz: Datenformat für strukturierte Daten — Key-Value-Paare und Listen, mit Einrückung statt Klammern.

Lesbarer als JSON, Standard für Markdown-Frontmatter und Konfigurations-Dateien. Beispiel: "title: Mein Post\nauthor: Autor".

Wikilinks

Kurz: Verlinkung zwischen Markdown-Notes mit [[Note-Name]]-Syntax. Obsidian-spezifisch, auch in Logseq und einigen Wiki-Engines.

Wikilinks sind backlinks-fähig: Obsidian zeigt automatisch, welche Notes auf eine andere verweisen. Varianten: [[Note|Alias]], [[Note#Heading]], [[Note#^block-id]].

Block-Reference

Kurz: Verweis auf einen einzelnen Block (Absatz, Liste, Code) innerhalb einer anderen Note. Obsidian-spezifisch.

Syntax: Block-ID am Zeilenende (`Text ^id`), Verweis mit [[Note#^id]] oder Embed mit ![[Note#^id]]. Ermöglicht atomares Vernetzen von Wissen.

Callout

Kurz: Hervorgehobener Markdown-Block mit Icon und Typ-Indikator. Erweiterung von Blockquotes in Obsidian.

Syntax: > [!info] oder > [!warning], gefolgt von Inhalt. Typen: info, tip, warning, danger, example, quote. Visuell als Box mit Icon gerendert.

Mermaid

Kurz: JavaScript-Library für Text-basierte Diagramme. Eingebettet in Markdown via Code-Block mit "mermaid" als Sprache.

Unterstützt Flowcharts, Sequence-Diagramme, Gantt-Charts, Class-Diagrams. GitLab und Obsidian rendern Mermaid out-of-the-box. GitHub rendert Mermaid in Issues und auf github.com seit 2022.

KaTeX

Kurz: JavaScript-Library für LaTeX-Math-Rendering im Browser. Schneller als MathJax, ~95% LaTeX-Coverage.

Eingebunden via $inline$ oder $$block$$ in Markdown. GitLab, Obsidian und Pandoc-mit-Plugin unterstützen KaTeX. GitHub seit 2022 mit eingeschränktem Set.

MathJax

Kurz: JavaScript-Library für Math-Rendering. Aelterer Konkurrent zu KaTeX, breitere LaTeX-Coverage aber langsamer.

Wird von vielen wissenschaftlichen Plattformen genutzt. Pandoc kann zwischen KaTeX und MathJax beim HTML-Output wählen.

ATX-Heading

Kurz: Markdown-Heading-Stil mit # als Präfix. # H1, ## H2, bis ###### H6.

Der gebräuchlichste Heading-Stil. Vorteil: kompakt, schreib-effizient. Nachteil: visuell weniger sofort sichtbar als Setext.

Setext-Heading

Kurz: Markdown-Heading-Stil mit Unterstreichung (=== für H1, --- für H2). Aelter, weniger gebräuchlich.

Nur für H1 und H2 verfügbar. Vorteil: visuell sofort als Heading erkennbar im rohen Quelltext. Nachteil: schreib-aufwändiger.

Inline-Code

Kurz: Monospace-Schrift innerhalb eines normalen Absatzes, mit Backticks umrahmt: `code`.

Universell unterstützt. Für Variablen-Namen, kurze Code-Schnipsel, Tasten-Bezeichnungen. Bei mehrzeiligem Code: Code-Block (Fenced) verwenden.

Code-Fence

Kurz: Markdown-Code-Block mit drei Backticks (```) als öffnender und schließender Marker.

Sprache nach den öffnenden Backticks aktiviert Syntax-Highlighting. Universell unterstützt. Alternative: Indented Code-Block mit 4 Leerzeichen (Legacy).