Markdown Preview
Understand Markdown Preview
Diese Vorschau rendert Markdown während des Tippens zu HTML, damit Sie sehen, wie eine README oder ein langer Kommentar herauskommt.
How it works
Das Markdown wird durch eine Reihe nacheinander angewandter Regeln umgewandelt: zuerst eingezäunte Codeblöcke, damit ihr Inhalt escapt und in Ruhe gelassen wird, dann Überschriften, Blockzitate, Linien, Listen, Inline-Code, fett, kursiv und Links. Das entstehende HTML wird gegen eine Positivliste gefiltert – Überschriften, Absätze, Listen, code, pre, strong, em, blockquote, hr, br und Links –, und jedes Attribut außer einem href mit http, https oder mailto entfällt, roher HTML-Code in der Quelle kann also nicht ausgeführt werden.
When to use it
- Überschriften und Code-Zäune einer README prüfen, bevor Sie sie pushen.
- Sehen, ob ein langer Issue-Text oder Kommentar so erscheint, wie Sie es beabsichtigt haben.
- Einen Markdown-Ausschnitt in HTML umwandeln, das Sie in ein CMS oder eine E-Mail einfügen können.
- Prüfen, ob eine Liste oder ein verschachtelter Codeblock korrekt geschrieben ist.
Watch out for
- Dies ist eine Teilmenge von CommonMark, kein GitHub Flavored Markdown. Tabellen, Aufgabenlisten, Durchstreichung, Fußnoten und Bilder werden nicht gerendert – stattdessen erscheint ihr Quelltext.
- Unterstriche innerhalb eines Wortes werden als Hervorhebung gelesen, snake_case_name erscheint also mit kursivem Mittelteil. CommonMark tut das bewusst nicht; setzen Sie Bezeichner in Backticks.
- Die Verschachtelung ist flach. Eine Liste innerhalb eines Blockzitats oder eine eingerückte Unterliste kommt nicht so heraus, wie ein vollständiger Parser sie erzeugt.
- Roher HTML-Code in der Quelle wird vom Sanitizer auf seinen Textinhalt reduziert. Das ist Absicht und macht diese Vorschau strenger als GitHub, das eine begrenzte Menge Tags erlaubt.
Not the right tool for: Zu bestätigen, wie GitHub eine Datei genau rendert. GitHub legt eigene Erweiterungen und einen eigenen Sanitizer über CommonMark; für eine bytegenaue Prüfung pushen Sie in einen Branch und sehen nach.
Frequently Asked Questions
Welche Markdown-Syntax wird unterstützt?
Die CommonMark-Spezifikation: # Überschriften (6 Ebenen), **fett**, *kursiv*, `Inline-Code`, ```eingezäunte Codeblöcke```, [Links](url), , - ungeordnete Listen, 1. geordnete Listen, > Blockzitate, --- horizontale Linien und | Tabellen | -Syntax.
Wie sehe ich eine Vorschau einer GitHub-README?
Fügen Sie den Inhalt Ihrer README.md in den Editor ein. GitHub verwendet einen strengen CommonMark-Parser mit zusätzlichen GFM-Erweiterungen (GitHub Flavored Markdown) für Aufgabenlisten, Tabellen und Durchstreichung. Die Vorschau kommt der Darstellung von GitHub nahe.
Kann ich das erzeugte HTML exportieren?
Ja – klicken Sie auf "HTML kopieren", um die erzeugte HTML-Ausgabe zu erhalten. Das ist nützlich, um formatierte Inhalte in E-Mail-Programme, CMS-Systeme mit HTML-Eingabe oder HTML-E-Mail-Vorlagen einzufügen.
How to Use Markdown Preview
- Paste or type your input in the input area above.
- The tool processes your input automatically or click Run.
- Copy or download the result using the action buttons.
- Use Ctrl+Enter to run quickly from the keyboard.