Markdown-Struktur vor der Veröffentlichung prüfen

Fügen Sie eine README oder einen Dokumentationsentwurf ein, um Gliederung und Befunde zu sehen: Ebenensprünge, wiederholte Anker, nicht geschlossene Codeblöcke, leere oder undefinierte Links und Leerzeichen am Zeilenende. Das Markdown wird als Text gelesen, nie gerendert, und kein Link wird geöffnet.

Läuft lokal in deinem Browser
Dieses Werkzeug verarbeitet alle Daten lokal in deinem Browser.
Markdown-QuelltextPrüft Strukturprobleme ohne Rendering, Upload oder Öffnen von Links.

Ein Markdown-Dokument vor der Veröffentlichung prüfen

Die Prüfung liest das eingefügte Markdown als Text und antwortet mit drei Dingen: der Gliederung der Überschriften, den Zählern für Überschriften, Links und Codeblöcke und den Strukturbefunden, die sich aus dem Quelltext belegen lassen. Sie rendert das Dokument nicht, lädt es nicht hoch und öffnet keinen Link, ein noch nicht teilbarer Entwurf lässt sich also direkt hier prüfen.

Alles läuft auf der Seite. In einer gemessenen Sitzung waren die einzigen Anfragen, die den Browser verließen, die Analyse des Anbieters selbst: Entwurf, Links und Gliederung blieben im Tab, weshalb die Prüfung auch ohne Netzverbindung weiterarbeitet.

  1. Fügen Sie die README, den Leitfaden oder den Dokumentationsentwurf in Markdown-Quelltext ein, oder wählen Sie Beispiel laden, um mit einem Dokument zu beginnen, das bereits eine doppelte Überschrift und einen leeren Link enthält.
  2. Wählen Sie Markdown prüfen. Die Gliederung listet jede Überschrift mit dem erzeugten Anker und der Zeilennummer, der Bericht sammelt die Funde jeder Regel, und die Zähler zeigen die Summen für Überschriften, Links und Codeblöcke.
  3. Lesen Sie die Befunde von oben nach unten: Ebenensprung, doppelter Anker, nicht geschlossener Codeblock, Link mit leerem Text oder ohne Ziel, Referenzlink ohne Definition, Zeile mit Leerzeichen am Ende, die nicht die zwei des harten Umbruchs sind, Raute ohne Leerzeichen dahinter und ein Dokument ohne Überschrift der Ebene eins.
  4. Wählen Sie Kopieren für den Bericht als reinen Text, oder Herunterladen, um ihn als markdown-report.txt neben der Quelldatei zu speichern.
  5. Wählen Sie Leeren, um beide Bereiche vor dem nächsten Dokument zu leeren.

Was die Prüfung liest und was sie unangetastet lässt

Was als Link zählt

Inline-Links zählen mit optionalem Titel, etwa [Text](https://example.com "Titel"), und mit einer Ebene Klammern im Ziel, wie sie Wikipedia-artige URLs brauchen. Referenzlinks zählen, wenn das Dokument die Marke irgendwo definiert: die vollständige Form [Text][ref], die zusammengezogene Form [Text][] und die Kurzform [ref] lösen gegen eine Zeile wie [ref]: https://example.com auf, mit oder ohne Titel. Auch Autolinks — <https://example.com> und <mailto:docs@example.com> — zählen.

Drei Dinge, die wie Links aussehen, bleiben bewusst außen vor: Bilder als ![Alt](bild.png), Link-Syntax in Inline-Code wie `[Text](url)` und HTML-Tags wie <a href="https://example.com">, die Auszeichnung sind und kein Autolink. Ein Referenzlink ohne Definition wird gemeldet statt gezählt.

Wie Überschriften, Blöcke und Front Matter gelesen werden

Beide Überschriftenstile sind bekannt: ATX (# bis ######, mit bis zu drei Leerzeichen Einrückung und optionalem abschließendem #-Lauf) und Setext (eine Absatzzeile mit ==== für Ebene eins oder ---- für Ebene zwei darunter). Anker entstehen wie bei statischen Seitengeneratoren — Kleinschreibung, ohne Satzzeichen, Leerzeichen werden zu Bindestrichen — deshalb kollidieren „Install now!“ und „Install now?“ in #install-now, und der zweite Fall wird als doppelter Anker gemeldet.

Ein mit ``` oder ~~~ geöffneter Block verbirgt seinen Inhalt vor allen anderen Regeln; geschlossen wird er durch eine Abschlusszeile, die mindestens so lang ist wie die öffnende; ein offener Block wird an der Zeile gemeldet, in der er begann. Ein Dokument, das mit einer --- Zeile beginnt, wird bis zur nächsten --- oder ... Zeile als YAML-Front-Matter gelesen, sodass Doppelpunkte, Klammern und Leerzeichen am Zeilenende der Metadaten nicht als Text gemeldet werden.

Was die Prüfung nicht tut

Sie rendert Markdown nicht und kann deshalb nicht zeigen, wie die Seite aussehen wird, und sie ruft Linkziele nicht ab, eine unerreichbare URL wird also nie gemeldet. Sie prüft die hier beschriebenen Regeln und sonst nichts: Zeilenlänge, Aufzählungszeichen, Leerzeilen um Blöcke, Tabellenausrichtung und die übrigen Stilregeln eines vollständigen Linters bleiben außen vor, und ein um vier Leerzeichen eingerückter Codeblock wird als gewöhnlicher Text gelesen.

Ein Dokument mit 4000 Zeilen und 4000 Links wurde in einem Desktop-Browser in etwa 0,6 s analysiert, und die Arbeit entsteht beim Klick auf die Schaltfläche, nicht beim Tippen. Für eine Prüfung über ein ganzes Repository mit festem Regelwerk bleibt ein Linter auf der Kommandozeile das bessere Werkzeug; diese Seite antwortet für einen Entwurf, ohne ihn hochzuladen.

Zuletzt verwendet: