Markdown-Lint
Prüfe Markdown mit markdownlint, dem von vielen Editoren und CI-Pipelines verwendeten Linter, auf Stil- und Syntaxprobleme. Füge ein Dokument ein und erhalte jeden Befund mit Zeile, Regel wie MD001 und Erklärung. Auf Wunsch erhältst du eine korrigierte Version, in der markdownlint behebbare Probleme wie Leerzeilen, Listenzeichen und Abstände anpasst.
Häufig gestellte Fragen
Welche Regeln werden geprüft?
Alle Regeln, die markdownlint standardmäßig aktiviert, von MD001 (Überschriftenebenen steigen jeweils um eins) bis zu Regeln für Listen, Leerzeilen, Codeblöcke, Links und Hervorhebungen. Die Zeilenlängenregel MD013 ist deaktiviert, sofern du keine maximale Zeilenlänge festlegst.
Wie schalte ich Regeln aus?
Führe sie im Feld „Zu deaktivierende Regeln“ auf, getrennt durch Kommas oder Leerzeichen. Verwende Nummern wie MD033 oder Namen wie no-inline-html. Auch Inline-Kommentare im Dokument wie <!-- markdownlint-disable MD033 --> funktionieren.
Was bewirkt die Korrekturoption?
Sie wendet die automatischen Korrekturen von markdownlint an, zum Beispiel Leerzeilen um Überschriften und Listen einzufügen, Listenzeichen zu vereinheitlichen oder nachgestellte Leerzeichen zu entfernen, und zeigt das korrigierte Dokument an. Befunde ohne automatische Korrektur musst du selbst beheben.
Welche markdownlint-Version wird verwendet?
markdownlint 0.42.0, die Bibliothek, auf der die markdownlint-Erweiterung für Visual Studio Code und markdownlint-cli2 aufbauen. Bei gleicher Version und Standardkonfiguration melden sie dieselben Befunde.
Warum wird meine erste Überschrift beanstandet?
Regel MD041 erwartet, dass ein Dokument mit einer Überschrift der obersten Ebene beginnt, und MD025 erlaubt nur eine solche Überschrift. Wenn deine Plattform den Titel selbst hinzufügt, deaktiviere diese Regeln für dein Dokument.
Wie viele Befunde werden angezeigt?
Die Gesamtzahl wird immer angegeben, und die ersten 500 Befunde stehen in der Tabelle. Behebe die ersten und führe die Prüfung erneut aus, um die übrigen zu sehen.