Was PreviewMD rendert und was es rendert
Jeder Renderer hier unten steckt in der App. Beim Zeichnen eines Dokuments wird nichts nachgeladen, kein CDN angesprochen, keine Telemetrie verlässt das Gerät — deshalb erscheint Quick Look sofort und deshalb funktioniert das Ganze auch im Flugzeug.
Diese Seite wird vom selben Stapel gerendert. Schalte oben auf Quelltext um, und du siehst das Markdown hinter jedem Beispiel darauf.
Die Module
| Modul | Version | Was es tut |
|---|---|---|
| markdown-it | 14.1.0 | Der Parser: CommonMark plus die GitHub-Erweiterungen weiter unten |
| KaTeX | 0.16.22 | Mathematik, gesetzt statt abgebildet |
| Mermaid | 11.16.1 | Diagramme, aus Text gezeichnet |
| highlight.js | 11.11.1 | Syntaxhervorhebung, fast zweihundert Sprachen |
| @vscode/markdown-it-katex | 1.1.2 | Findet $…$ und $$…$$ im Text und gibt sie an KaTeX weiter |
| markdown-it-task-lists | 2.1.0 | - [x]-Kästchen |
| markdown-it-footnote | 4.0.0 | Fußnoten und ihre Rücklinks |
| markdown-it-emoji | 2.0.2 | :shortcodes: |
| markdown-it-front-matter | 0.2.4 | YAML-Front-Matter, versteckt statt gedruckt |
| jsdiff + diff2html | — | Die Diff-Ansicht und ihre Hervorhebung auf Wortebene |
| github-markdown-css | — | Der Seitenstil, hell und dunkel |
Jedes bringt seinen eigenen Lizenzhinweis mit, in der App wortgetreu wiedergegeben unter Hilfe ▸ Danksagungen.
Mathematik
KaTeX setzt Formeln, also skalieren sie, lassen sich auswählen und als Text kopieren, statt als unscharfes Bild anzukommen. Mathematik im Fließtext steht zwischen einfachen Dollarzeichen — die Geschwindigkeit an jedem Punkt einer Umlaufbahn ist — und eine Formel in eigener Zeile zwischen doppelten:
Matrizen, Summen und ausgerichtete Gleichungen funktionieren genauso:
Diagramme
Ein eingezäunter Block mit der Marke mermaid wird zur Zeichnung. Der Text bleibt die Wahrheit: ändere eine Zeile, und das Bild ändert sich — und die Datei ist weiterhin eine Textdatei, die deine Versionsverwaltung vergleichen kann.
graph LR
A[Schreiben] --> B[Vorschau]
B --> C{Sieht gut aus?}
C -- ja --> D[Export]
C -- nein --> A
Sequenzdiagramme, für alles mit einem Hin und Her:
sequenceDiagram
participant F as Finder
participant Q as Quick Look
participant P as PreviewMD
F->>Q: Leertaste auf README.md
Q->>P: rendere diese Datei
P-->>Q: die gerenderte Seite
Q-->>F: gezeigt, keine App gestartet
Und Anteile, wo eine Tabelle dich selbst rechnen ließe:
pie showData
title Woraus eine README besteht
"Text" : 55
"Codeblöcke" : 30
"Tabellen" : 10
"Diagramme" : 5
Zustands- und Klassendiagramme, Gantt-Charts und der ganze übrige Vorrat von Mermaid werden genauso gerendert.
Code
Eingezäunte Blöcke hebt highlight.js hervor, das fast zweihundert Sprachen kennt. Die Sprache steht hinter dem öffnenden Zaun:
struct Entry: Comparable {
let clock: UInt64
let device: UUID
static func < (a: Entry, b: Entry) -> Bool {
// Bei Gleichstand entscheidet die Geräte-ID, damit die Reihenfolge überall gleich ist.
(a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
}
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
"""Gesamtes Delta-v für einen Übergang zwischen Kreisbahnen."""
first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
return first + second
Ein Block ohne Sprache bleibt einfacher Festbreitentext, und Code im Fließtext braucht überhaupt keine Sprache.
Die GitHub-Erweiterungen
Was GitHub dem Markdown hinzugefügt hat — und was eine README daher voraussetzt:
- Aufgabenlisten, mit gezeichneten Kästchen
- Auch die, die noch offen sind
Durchgestrichenesfür das, was nicht mehr gilt- Fußnoten[1], numeriert und zurückverlinkt
- Autolinks: https://previewmd.xfanta.com wird von selbst zum Link
- Emoji per Kurzschreibweise: 🚀 ✨ ✅
Note
Hinweisblöcke sind GitHubs eigene Konvention und Teil keiner Markdown-Spezifikation — ein Zitat, dessen erste Zeile die Art benennt.
Warning
Es gibt fünf: Note, Tip, Important, Warning und Caution.
Die am Ende des Dokuments landen, mit einem Pfeil zurück dorthin, wo du gelesen hast. ↩︎
Die leiseren
Front Matter. Ein YAML-Block ganz oben in einer Datei, zwischen ----Zeilen, ist Metadaten für einen Generator statischer Seiten — nichts, was du lesen wolltest. Er wird ausgewertet und versteckt, statt als Tabelle voller Kauderwelsch gedruckt zu werden.
Bilder. Lokale Bilder, auf die ein Dokument zeigt, werden angezeigt, geladen aus dem Ordner, in dem das Dokument liegt. Über das Netz wird nichts geholt, also sagt ein Dokument mit einem falschen Pfad das auch, statt hängen zu bleiben.
Tabellen. Gewöhnliche GFM-Tabellen mit Strichen, die Ausrichtung aus den Doppelpunkten in der Trennzeile. Breite scrollen, statt die Seite zu zerreißen.
All das auf deinem Mac lesen
PreviewMD rendert alles auf dieser Seite in Quick Look, im eigenen Fenster und im exportierten HTML und PDF — auf Mac, iPad und iPhone, kostenlos.
Der Spickzettel führt jedes Zeichen mit seinem Ergebnis auf, und was Markdown ist erzählt, woher das Format kommt.