Zum Inhalt

Markdown-Preview-Plugin

Eine Live-Vorschau des aktiven Markdown-Dokuments direkt daneben, dargestellt in einem andockbaren Panel, das sich beim Tippen aktualisiert. Der Renderer kommt ohne Abhängigkeiten aus (er verwendet Qts eingebaute Rich-Text-Ansicht, keine Web-Engine), daher ist dieses Plugin immer verfügbar und bringt keine schweren Abhängigkeiten mit.

Wo zu finden

Ansicht ▸ Markdown-Vorschau öffnet (oder schließt) das Vorschau-Dock für den aktuellen Tab. Das Dock bevorzugt die rechte Seite und kann wie jedes andere Panel gezogen, abgelöst oder als Tab angeordnet werden.

Verhalten

  • Live-Rendering. Die Vorschau wird beim Tippen neu gerendert, mit Verzögerung (Debounce), damit die Eingabe flüssig bleibt (bei sehr großen Dateien lockert sich die Verzögerung automatisch).
  • Dem Cursor folgen. Mit aktiviertem Cursor folgen (Werkzeugleiste) scrollt die Vorschau zu dem Block, den Sie bearbeiten, sobald der Cursor in eine andere Zeile wandert. Weil nur eine Cursorbewegung scrollt, springt die Vorschau bei einer Suche zum Treffer und bleibt dann in Ruhe: Sie können vom Treffer wegscrollen, und die Vorschau bleibt dort, bis Sie den Cursor wieder bewegen. Deaktivieren Sie die Option, um die Vorschau völlig unabhängig zu scrollen. Die Einstellung wird gemerkt.
  • Theme-bewusst. Die Vorschaufarben stammen aus dem aktiven Editor-Theme (Text, Codeblöcke, Blockzitate, Links), sodass die Vorschau zu einem hellen oder dunklen Theme passt und sich beim Theme-Wechsel live aktualisiert. Diese Farben können Sie im Theme Editor unter den Markdown-Kategorien feinjustieren.
  • Exportieren / im Browser öffnen. Die Werkzeugleiste kann das gerenderte HTML in eine Datei exportieren oder im Standardbrowser öffnen. In beiden Fällen erhalten Sie eine saubere, eigenständige Seite: schlichtes, semantisches Markup ohne das Gerüst, das die Vorschau nur für sich selbst braucht, und ein festes helles Stylesheet, damit die geteilte Datei unabhängig von Ihrem Editor-Theme normal lesbar ist.
  • Panelgröße. Die Vorschau behält einen Anteil des Fensters statt einer festen Breite und wächst und schrumpft daher mit dem Fenster — siehe Gespeichertes Layout.

Sichtbarkeit der Vorschau

Die Sichtbarkeit der Vorschau wird pro Datei gemerkt, sowohl innerhalb einer Sitzung als auch über Neustarts hinweg:

  • Markdown-Dateien (.md, .markdown, .mdown, .mkd, .mkdn, .mdwn, .markdn, .mdtxt) öffnen die Vorschau automatisch, wenn Sie sie zum ersten Mal ansehen. Dieser „Auto-Öffnen“-Standard ist ein dauerhafter Schalter unter Ansicht ▸ Markdown-Vorschau automatisch öffnen.
  • Andere Dateien nicht — aber Sie können die Vorschau für jede Datei mit Ansicht ▸ Markdown-Vorschau öffnen; die Datei wird dann als Markdown gerendert.
  • Innerhalb einer Sitzung wird Ihre Wahl für einen Tab wiederhergestellt, wenn Sie zu ihm zurückwechseln.
  • Über Neustarts hinweg wird Ihre ausdrückliche Wahl für eine Datei gemerkt: Schließen Sie die Vorschau für eine Datei, bleibt sie beim nächsten Öffnen dieser Datei geschlossen; öffnen Sie die Vorschau für eine Datei, die sich nicht automatisch öffnen würde, öffnet sie sich erneut. Dateien, deren Vorschau Sie nie ausdrücklich angefasst haben, folgen einfach jedes Mal dem Auto-Öffnen-Standard — ein später aktiviertes Auto-Öffnen öffnet also weiterhin Vorschauen, die Sie nie bewusst geschlossen haben.

Was gerendert wird

  • Inline-Auszeichnung — *kursiv*, **fett**, ***fett kursiv***, ~~durchgestrichen~~, Inline-code und harte Zeilenumbrüche.
  • Überschriften — sowohl in der #-Form als auch unterstrichen (Setext).
  • Listen — geordnet und ungeordnet, verschachtelt, kompakt oder locker (eine lockere Liste erhält Absatzabstände), beginnend bei der Zahl, die Sie geschrieben haben, und Aufgabenlisten: - [ ] und - [x] werden zu ☐ und ☑.
  • Tabellen — Pipe-Tabellen mit Ausrichtung pro Spalte (links, zentriert, rechts). Eine zu kurze Zeile wird aufgefüllt, eine überzählige Zelle entfällt, und eine breite Tabelle bricht um, statt abgeschnitten zu werden.
  • Code — eingezäunte wie eingerückte Blöcke, gezeichnet in einem umrandeten, gefüllten Kasten in einer Festbreitenschrift, sodass ein Block sich vom Text abhebt und ASCII-Diagramme und ausgerichtete Spalten ihre Form behalten.
  • Links und Bilder — inline, als Referenz ([Text][ref] mit der Definition irgendwo in der Datei) und nackte http://-, https://- oder www.-Adressen, die von selbst zu Links werden. Bildpfade werden relativ zur Datei aufgelöst.
  • Blockzitate und horizontale Linien.
  • YAML-Front-Matter — der --- … ----Metadatenblock, den manche Werkzeuge am Dateianfang erwarten, wird als yaml-Codeblock gezeigt und nicht für eine Überschrift gehalten.

Rohes HTML wird bewusst als Text gezeigt: Markup wird escaped statt ausgeführt, sodass die Vorschau eines Dokuments, das Sie nicht selbst geschrieben haben, nichts ausführen kann. HTML-Blöcke und Fußnoten werden nicht gerendert.

Ein Klick auf einen Link in der Vorschau öffnet ihn nur, wenn das Ziel http, https oder mailto ist; ein #fragment scrollt die Vorschau zu der Überschrift. Jedes andere Ziel — ein file:-Pfad, ein einfacher oder relativer Pfad, eine javascript:-Adresse, das eigene Schema irgendeiner Anwendung — wird ignoriert, und die Statusleiste nennt den Link, der nicht geöffnet wurde, und den Grund. Der Grund ist das Dokument selbst: eine Markdown-Datei, die Sie geklont oder heruntergeladen haben, ist der Text eines anderen, und ein einziger Klick darin darf kein Programm auf Ihrem Rechner starten können.

Wenn Sie mit der Maus über einen Link fahren, sehen Sie vor dem Klick, wohin er führt — mit einer zweiten Zeile, wenn die Vorschau ihn nicht öffnen wird.

Siehe auch

  • HTML-Vorschau — vollwertige Vorschau (CSS/JavaScript) für HTML und PHP, mit QtWebEngine.
  • Theme Editor — die Markdown-Farben der Vorschau anpassen.