Markdown Preview

Live Markdown preview

Live Markdown preview Läuft lokal in Ihrem Browser

About the

Die Markdown-Vorschau stellt Ihren Markdown während der Eingabe in einer Nebeneinanderansicht dar und folgt CommonMark mit den GitHub-Erweiterungen, die die meisten Leute tatsächlich verwenden: Tabellen, Aufgabenlisten, umzäunte Codeblöcke, Durchstreichen und Autolinks. Dies ist die schnellste Möglichkeit, eine README-Datei vor dem Übertragen zu überprüfen, da die Unterschiede zwischen dem Erscheinungsbild von Markdown in der Quelle und dem gerenderten Erscheinungsbild nicht offensichtlich sind und insbesondere die Tabellensyntax stillschweigend fehlschlägt, wenn ein einzelner Pipe- oder Bindestrich falsch ist. The rendered HTML can also be copied out if you need it somewhere that does not process Markdown itself.

Where people use the

Überprüfen Sie, ob eine README-Datei korrekt gerendert wird, bevor Sie sie übertragen.
Verfassen von Release Notes oder eines Changelogs mit Live-Ansicht des Ergebnisses.
Konvertieren eines Markdown-Dokuments in HTML für ein CMS, das Markdown nicht akzeptiert.
Überprüfen Sie die Markdown-Pull-Anfrage einer anderen Person und sehen Sie, wie sie aussehen wird.

How to use the

1
Fügen Sie Ihren Markdown ein oder schreiben Sie ihn
Der Editor akzeptiert alles von einem einzelnen Absatz bis hin zu einem vollständigen Dokument mit Überschriften, Listen, Links und Code-Zäunen.
2
Sehen Sie sich das gerenderte Panel an
Die Vorschau wird bei jedem Tastendruck aktualisiert, sodass eine defekte Tabelle oder ein nicht geschlossener Zaun sofort und nicht erst nach einem Veröffentlichungsschritt angezeigt wird.
3
Korrigieren Sie die Quelle, nicht die Vorschau
Die Vorschau ist schreibgeschützt. When something renders wrongly, the cause is almost always a missing blank line before a list or a table header without a delimiter row.
4
Kopieren Sie den HTML-Code, wenn Sie ihn benötigen
Wechseln Sie zur HTML-Ansicht, um das generierte Markup zu übernehmen. Dies ist nützlich zum Einfügen in ein CMS, das HTML anstelle von Markdown erwartet.

Tipps und Best Practices

Lassen Sie vor und nach jedem Blockelement eine Leerzeile. Die meisten rätselhaften Rendering-Fehler sind fehlende Leerzeilen.
Verwenden Sie abgeschirmte Codeblöcke mit einem Sprachnamen, damit der Code hervorgehoben und nicht als einfacher Text behandelt wird.
Behalten Sie in langen Dokumenten einen Satz pro Zeile bei; Dadurch werden die Unterschiede später lesbar.

Häufig gestellte Fragen

Welche Markdown-Spezifikation wird verwendet?

CommonMark als Basis sowie die GitHub Flavored Markdown-Erweiterungen für Tabellen, Aufgabenlisten, abgeschirmten Code und Durchstreichen. Diese Kombination deckt das README-Format auf GitHub, GitLab und den meisten Dokumentationsseiten ab.

Warum wird meine Tabelle nicht gerendert?

Eine Tabelle benötigt eine Kopfzeile, unmittelbar gefolgt von einer Trennzeile aus Bindestrichen und einer Leerzeile vor dem Block. Jede Reihe muss die gleiche Anzahl an Rohren haben wie der Kopf. Wenn eines davon fehlt, wird das Ganze zu einem Textabschnitt mit Pipe-Zeichen darin.

Warum wurden meine Listenelemente in einem Absatz zusammengeführt?

Markdown benötigt eine Leerzeile zwischen einem Absatz und einer darauf folgenden Liste. Ohne sie werden die Listenmarkierungen als normaler Text behandelt.

Unterstützt es LaTeX oder Mathematik?

Nein. Mathe-Rendering erfordert eine separate Bibliothek wie KaTeX oder MathJax und eine andere Syntax. Ein Dollarzeichen-Ausdruck wird hier als einfacher Text gerendert.

Ist rohes HTML erlaubt?

Ja, Inline-HTML wird direkt weitergeleitet, was auch GitHub tut. Wenn Sie die Ausgabe an einem öffentlichen Ort veröffentlichen, bereinigen Sie sie zuerst, da Roh-HTML auch die Art und Weise ist, wie Skripte eingefügt werden.

Wohin geht mein Text?

Nirgends. Parsing and rendering happen in your browser with a JavaScript Markdown library. Nothing is saved or transmitted, so the draft is gone when you close the tab unless you copy it out.