Was ist Markdown?
Markdown ist eine leichtgewichtige Auszeichnungssprache, die entwickelt wurde, um Texte sowohl einfach lesbar als auch einfach konvertierbar zu machen. Sie eignet sich besonders für Dokumentation, Notizen und Webinhalte. Markdown wird unter anderem in README-Dateien auf GitHub, in Jupyter Notebooks, Blogs, Wikis und vielen weiteren Kontexten verwendet.
Da die ursprüngliche Spezifikation nicht vollständig eindeutig war, existieren heute zahlreiche Markdown-Varianten („Flavors“) wie GitHub Flavored Markdown, Pandoc Markdown oder CommonMark. Diese teilen sich eine gemeinsame Grundsyntax, unterscheiden sich aber in unterstützten Erweiterungen.
Markdown erlaubt in vielen Implementierungen die Einbettung von HTML, und zahlreiche Flavors unterstützen zusätzlich mathematische Formeln in LaTeX-Syntax (z. B. über MathJax oder Pandoc). Dadurch ist Markdown für Nutzerinnen und Nutzer mit LaTeX-Erfahrung leicht zugänglich und insgesamt gut lesbar.
Mit Werkzeugen wie Pandoc lässt sich Markdown in eine Vielzahl von Formaten konvertieren, darunter PDF, DOCX, HTML, EPUB oder PreTeXt. Für komplexe mathematische Texte ist Markdown jedoch nur eingeschränkt geeignet, da die meisten Varianten keine strukturierten Umgebungen für Theoreme, Lemmata oder Beweise bereitstellen.
Vor- und Nachteile von Markdown
Vorteile
- Sehr leicht zu erlernen
- Schnelle und unkomplizierte Syntax
- Konvertierbar in viele Ausgabeformate (PDF, Word, HTML, PreTeXt u. a.)
- Weit verbreitet und in vielen Plattformen nativ unterstützt (GitHub, Jupyter, Blogs, Wikis)
- Klartextformat → langfristig gut lesbar und zukunftssicher
Nachteile
- Begrenzte Kontrolle über Layout und typografische Feinheiten
- Kein integriertes Grafiksystem wie TikZ
- In der Grundsyntax keine Umgebungen für Theoreme, Definitionen usw.
- Unterschiedliche Flavors → kein vollständig einheitlicher Standard
- Erweiterte Funktionen (Mathematik, Referenzen) hängen von der jeweiligen Implementierung ab
Was ist MyST Markdown?
MyST (Markedly Structured Text) ist ein erweiterter Markdown-Flavor, der aus der Executable Books Community hervorgegangen ist und eng mit Jupyter Book verknüpft ist. MyST erweitert Markdown um eine Vielzahl von Funktionen, die aus dem Sphinx-/reStructuredText-Ökosystem stammen, darunter:
- Theorem-, Lemma-, Definition- und Proof-Umgebungen
- Direktiven und Rollen zur strukturierten Dokumentation
- Einbettung von ausführbarem Code (z. B. Jupyter-Zellen)
- Unterstützung für Querverweise, Bibliografien und komplexe Dokumentstrukturen
MyST eignet sich besonders für wissenschaftliche Artikel, Lehrmaterialien und technische Dokumentation. Eine Einführung findet sich unter https://mystmd.org/guide/quickstart.
Vor- und Nachteile von MyST Markdown
Vorteile
- Speziell für wissenschaftliche und technische Dokumente entwickelt
- Bietet strukturierte Umgebungen für mathematische Inhalte (Theoreme, Beweise usw.)
- Unterstützt ausführbaren Code und interaktive Elemente
- Gute Integration mit Jupyter Book und Sphinx
Nachteile
- Installation und Build-Prozess sind komplexer als bei einfachem Markdown
- Nutzung der Kommandozeile erforderlich
- Generierte HTML-Ausgaben bestehen oft aus mehreren Dateien und Assets → nicht immer leicht als Einzeldatei teilbar
- Stärker an ein bestimmtes Ökosystem gebunden → weniger universell als Standard-Markdown