Markdown-Parser

GFM (GitHub Flavored Markdown) ist ein Markdown-Dialekt, der von GitHub verwendet wird. Er erweitert Standard-Markdown um Funktionen wie Tabellen, Aufgabenlisten, durchgestrichenen Text und automatische Links.

Der Parser stellt eingezäunte Code-Blöcke dar. Für vollständige Syntaxhervorhebung mit Farben können Sie ihn mit einem CSS-Stylesheet kombinieren, das Code-Elemente gestaltet.

Ja! Schreiben Sie Ihr Markdown im Editor, kopieren Sie das gerenderte HTML und verwenden Sie es in Ihrer Dokumentation, Ihrem Blog oder Ihrer Website.

Das ursprüngliche Markdown (2004) ließ viele Grenzfälle undefiniert, sodass die Implementierungen auseinanderliefen. CommonMark ist die strenge Spezifikation, die diese Fälle klärt; GFM (GitHub Flavored Markdown) ist CommonMark plus Erweiterungen: Tabellen, Aufgabenlisten, Durchstreichungen, Autolinks und ein Disallowed-Raw-HTML-Filter. Dieses Tool rendert GFM und entspricht damit dem, was Sie auf GitHub sehen.

Inline-Code umschließen Sie mit einfachen Backticks. Codezäune (Fenced Blocks) verwenden dreifache Backticks mit einem Sprach-Tag für Syntaxhervorhebung – etwa ```python in der ersten Zeile – oder Sie rücken jede Zeile um vier Leerzeichen ein (die ältere Syntax, die innerhalb von Listen problematisch ist). Dreifache Tilden funktionieren ebenfalls als Zaun, wenn Ihr Code selbst Backticks enthält.

Ja – Inline-HTML-Tags werden unverändert in die Ausgabe übernommen. Die Disallowed-Raw-HTML-Erweiterung von GFM entfernt nur einige wenige gefährliche Tags (script, style, iframe und Verwandte), sofern der Filter aktiviert ist. Zwei Einschränkungen: Blocklevel-HTML umschließt Inhalte, innerhalb derer die Markdown-Syntax nicht mehr verarbeitet wird (Leerzeilen sind entscheidend), und alle von Nutzern eingereichten Markdown-Inhalte müssen über einen Tag-Filter hinaus gegen XSS abgesichert werden.

Zeilen werden durch Pipes getrennt, mit einer Trennzeile aus Bindestrichen unter der Kopfzeile. Doppelpunkte steuern die Ausrichtung: Doppelpunkt-Bindestrich links bedeutet linksbündig (Standard), Doppelpunkte an beiden Enden zentriert, Bindestrich-Doppelpunkt rechtsbündig. Zellen dürfen keine Blockelemente enthalten; ein literales Pipe-Zeichen schreiben Sie als \|; die äußeren Pipes jeder Zeile sind optional. Komplexere Layouts erfordern rohes HTML oder eine Dokumentations-Engine.

Die üblichen Verdächtigen: inkonsistente Einrückung (verschachtelte Elemente müssen in der Regel am ersten Zeichen des Inhalts des übergeordneten Elements ausgerichtet sein), eine fehlende Leerzeile zwischen einem Absatz und einer Liste oder Tabulatoren, die mit Leerzeichen gemischt sind. CommonMark spezifiziert für all dies genaue Regeln. Tabulatoren in Leerzeichen umzuwandeln und Leerzeilen um Listen herum einzufügen, behebt die allermeisten Verschachtelungsfehler.