Markdown-Portabilität prüfen
Füge Markdown-Quelltext ein und prüfe, welche Elemente je nach Anzeigeumgebung – etwa GitHub, einem strikten CommonMark-Renderer oder einem vereinfachten Renderer – anders erscheinen oder nicht funktionieren.
Die Verarbeitung erfolgt lokal in Ihrem Browser. Ihre Datei wird niemals hochgeladen.
Anleitung Tool
- Füge Markdown-Quelltext, README oder Dokumentinhalt ein. Er wird lokal im Browser verarbeitet und nicht übertragen.
- Starte die Portabilitätsprüfung.
- Lies markierte Elemente, mögliche Inkompatibilitäten und betroffene Renderer.
- Nutze eine vorgeschlagene Umschreibung, wenn sie sicher ist. Viele Fälle lassen sich ohne Kenntnis der Absicht nicht automatisch korrigieren.
Annahmen
- Geprüft werden sieben konkrete Fälle: nackte URLs, eingerückte Codeblöcke mit Tabs, GFM-Tabellen, GFM-Durchstreichung, GFM-Aufgabenlisten, nicht definierte Referenzlinks/-bilder und rohe HTML-Blöcke mit oft gefilterten Tags.
- Zeilenbewusster Textscanner, kein vollständiger Markdown-Parser. Eingezäunte Codeblöcke werden absichtlich ausgelassen.
- Referenzlinks gelten nur dann als defekt, wenn keine passende Definition im Dokument vorkommt; der Abgleich ist wie in CommonMark nicht nach Groß-/Kleinschreibung unterscheidend.
Quellen und Referenzdaten
Methodik
Spezifische Musterprüfungen erkennen die sieben Fälle außerhalb eingezäunter Codeblöcke und gleichen sie mit bekannten Unterschieden zwischen GFM, CommonMark und verbreiteten vereinfachten Renderern ab. Nur eindeutige Korrekturen wie das Einklammern einer nackten URL in spitze Klammern werden vorgeschlagen.
Rechenbeispiel
Nackte URL ohne Linksyntax
Eingaben: Siehe https://example.com für Details.
Ergebnis: GFM macht daraus automatisch einen Link; striktes CommonMark kann es als unverlinkten Text belassen. Sichere Umschreibung: `Siehe <https://example.com> für Details.`
Referenzlink ohne Definition
Eingaben: Lies den [Migrationsleitfaden][missing-ref].
Ergebnis: Es gibt keine Definition `[missing-ref]: URL`. Der Verweis erscheint als Syntax oder defekter Link; ein Ziel wird nicht erfunden.
GFM-Tabelle
Eingaben: | Name | Alter | |------|-----| | Ada | 30 |
Ergebnis: Tabellen sind eine GFM-Erweiterung und gehören nicht zu einfachem CommonMark. Ein CommonMark-Renderer kann Pipes und Bindestriche als Text anzeigen.
Praktische Hinweise
- Nackte URLs in spitze Klammern setzen oder als `[Text](URL)` verlinken, wenn striktes CommonMark unterstützt werden soll.
- Eingezäunte Codeblöcke mit ``` statt eingerückter Tab-Codeblöcke bevorzugen.
- Ziele und Definitionen von Referenzlinks prüfen; fehlende Ziele sind echte Fehler.
- Rohe HTML-Tags wie script, iframe, style, object und embed in öffentlichem Markdown vermeiden; sie werden häufig gefiltert.
Häufige Fehler
- Annehmen, GFM-Tabellen oder Aufgabenlisten funktionierten überall, nur weil sie auf GitHub angezeigt werden.
- Einen defekten Referenzlink nur als Renderunterschied behandeln; er funktioniert in keinem Renderer.
Häufige Fragen
Warum ist eine nackte URL ein Hinweis, ein defekter Referenzlink aber ein Fehler?
Eine nackte URL bleibt lesbarer Text, auch wenn sie nicht verlinkt wird. Eine fehlende Referenzdefinition führt zu wörtlicher oder fehlender Linkdarstellung.
Warum konvertiert das Werkzeug GFM-Tabellen nicht automatisch?
Einfaches CommonMark kennt keine Tabellenstruktur. Eine automatische Umwandlung könnte Struktur oder Bedeutung ändern.
Werden Inhalte in Codeblöcken geprüft?
Nein. Eingezäunter Code wird wörtlich dargestellt und absichtlich nicht als Markdown-Syntax interpretiert.
Zuletzt geprüft:
Begrenzter zeilenorientierter Scanner, kein vollständiger Markdown-Parser. Andere CommonMark-/GFM-Sonderfälle wie verschachtelte Hervorhebungen, Fußnoten, Autolinks und HTML-Entities werden nicht abgedeckt. Für defekte Referenzen wird kein Ziel geraten.
Dieses Tool liefert eine unverbindliche Schätzung auf Grundlage der oben genannten Annahmen.
Design- und Tool-Einstellungen sowie gespeicherte und zuletzt verwendete Listen werden nur in diesem Browser gespeichert.