Markdown Linter
Prüfen Sie Markdown auf Stil- und Strukturprobleme
Markdown-Eingabe
Lint-Bericht
Was ist ein Markdown Linter?
Ein Markdown-Linter ist ein Code-Qualitätstool, das Markdown-Dateien analysiert und Stilverstöße, Formatierungsinkonsistenzen und strukturelle Probleme meldet, die die Lesbarkeit und Wartbarkeit der Dokumentation beeinträchtigen. Ähnlich wie markdownlint auf dem Desktop läuft dieser browserbasierte Linter lokal und identifiziert Probleme, ohne Ihre Inhalte hochzuladen.
Die meisten Markdown-Linter prüfen auf Probleme wie falsch verschachtelte Überschriftenebenen (von H1 direkt zu H3 springen), übermäßige Zeilenlängen, inkonsistente Listenmarker (Mischung von Aufzählungszeichen) und fehlende Leerzeilen um Überschriften. Das markdownlint-Projekt definiert einen umfassenden Regelsatz, der zum Industriestandard geworden ist.
Durch frühzeitiges Erkennen dieser Probleme spart ein Markdown-Linter Zeit bei der Dokumentationsüberprüfung und verhindert Verwirrung beim Leser. Der browserbasierte Ansatz bietet sofortiges Feedback ohne externe Abhängigkeiten — perfekt zum Schreiben von Dokumentation, READMEs, Blog-Posts und technischen Anleitungen.
So verwenden Sie den Markdown Linter
Folgen Sie diesen Schritten, um Ihr Markdown auf Stil und Struktur zu prüfen. Jeder Schritt verwendet die tatsächlichen Buttons und Panels auf dieser Seite.
Einfügen, Hochladen oder Beispiel laden
Fügen Sie Markdown im linken Markdown-Eingabe-Panel ein, oder klicken Sie auf Hochladen, um eine .md-Datei zu laden. Klicken Sie auf Beispiel, um Beispieldokumentation mit absichtlichen Stilproblemen zu sehen. Prüft Überschriftenhierarchie, Zeilenlänge, Listenkonsistenz und nachgestellte Leerzeichen.
Lint-Bericht ansehen
Das rechte Lint-Bericht-Panel listet Probleme mit Zeilennummern und Beschreibungen auf. Beheben Sie Überschriftensprünge, lange Zeilen, gemischte Listenmarker und Abstandsprobleme.
Bericht kopieren oder herunterladen
Klicken Sie auf Kopieren oder Herunterladen, um den Bericht zu verwenden. Verwenden Sie Löschen, um neu zu beginnen. Alle Verarbeitung erfolgt im Browser.
Praxisbeispiele
Dokumentations-Review-Workflows
Vor dem Einreichen von Pull Requests für Dokumentationsupdates den Linter ausführen, um Stilverstöße zu erkennen. Dies stellt Konsistenz in der Projektdokumentation sicher. Teams, die große Dokumentationsseiten wie GitHub Docs pflegen, verwenden ähnliche Tools in ihren CI/CD-Pipelines.
Standards für technisches Schreiben
Konsistente Überschriftenstruktur und Formatierung in Blog-Posts, Tutorials und Anleitungen durchsetzen. Besonders wichtig für Markdown-zentrierte Plattformen wie dev.to oder Medium.
Open-Source-Projektpflege
Von Beitragenden eingereichte Dokumentation auf Einhaltung des Projektleitfadens prüfen. Lokale Linter-Prüfungen helfen Beitragenden, sich selbst zu korrigieren. Viele Projekte fügen Linting zu GitHub Actions-Workflows hinzu.
Schnelle Qualitätsprüfung
Verwenden Sie es für einen letzten Durchlauf von README-Dateien, API-Dokumentation und Release Notes vor der Veröffentlichung. Erkennt leicht zu übersehende Probleme wie überflüssige Leerzeichen und ungültige Überschriftenreihenfolgen.
Häufig gestellte Fragen
Was ist der Unterschied zwischen Linter und Validator?
Ein Validator prüft, ob Markdown syntaktisch korrekt ist und richtig rendert. Ein Linter geht weiter und erzwingt Stilkonsistenz und Best Practices. Denken Sie an Validierung wie Rechtschreibprüfung und Linting wie Grammatikprüfung. Die markdownlint-Dokumentation erläutert diesen Unterschied.
Kann ich anpassen, welche Regeln der Linter prüft?
Dieser browserbasierte Linter verwendet einen integrierten Standard-Regelsatz, der sich auf die häufigsten Probleme konzentriert. Für volle Anpassung ermöglicht das Desktop-Paket markdownlint das Aktivieren/Deaktivieren spezifischer Regeln über Konfigurationsdateien.
Sendet der Linter mein Markdown an Server?
Nein. Das gesamte Linting erfolgt vollständig im Browser mit JavaScript. Ihr Markdown-Inhalt verlässt niemals Ihren Computer. Sicher für proprietäre Dokumentation, private Projekte und sensible Informationen.
Welchen Markdown-Dialekt unterstützt dieser Linter?
Dieser Linter folgt der CommonMark-Spezifikation als Basis, dem portabelsten und am weitesten verbreiteten Markdown-Standard. GitHub Flavored Markdown erweitert CommonMark um Tabellen und Durchstreichungen.
Wie behebe ich die gefundenen Probleme?
Jedes Problem enthält Zeilennummer und Beschreibung. Häufige Korrekturen: Überschriften logisch ordnen, nachgestellte Leerzeichen entfernen, Leerzeilen um Überschriften hinzufügen, Zeilen unter 80 Zeichen halten und konsistente Listenmarker verwenden. Der Markdown Guide hat detaillierte Syntaxbeispiele.
Kann ich dies für Produktionsdokumentation verwenden?
Für einmalige Prüfungen ja. Für automatisierte Durchsetzung in CI/CD-Pipelines integrieren Sie das Kommandozeilen-Tool markdownlint-cli in Ihren Build-Prozess.