Wichtige Fakten
- Kategorie
- Text & Schreiben
- Eingabetypen
- textarea, select, checkbox
- Ausgabetyp
- html
- Sample-Abdeckung
- 4
- API verfügbar
- Yes
Überblick
Der Markdown Lint- und Stil-Prüfer analysiert Ihre Markdown-Dokumente auf Formatierungsfehler, Stilprobleme und typografische Unstimmigkeiten. Das Tool prüft Ihren Text anhand von 15 markdownlint-Regeln sowie speziellen Typografie-Regeln und bietet eine automatische Behebung sicherer Fehler wie überflüssiger Leerzeichen oder fehlender Leerzeilen.
Wann verwenden
- •Vor dem Veröffentlichen oder Committen von README-Dateien und Dokumentationen in Repositories.
- •Zur Bereinigung von inkonsistenten Listenmarkern, fehlenden Code-Sprachangaben oder fehlerhaften Überschriften-Hierarchien.
- •Beim Mischen von chinesischen und lateinischen Schriftzeichen, um korrekte Abstände automatisch sicherzustellen.
So funktioniert es
- •Fügen Sie Ihren Markdown-Text in das Eingabefeld ein und wählen Sie den gewünschten Regelsatz (Standard, Streng oder Nachsichtig).
- •Aktivieren Sie optional die Option 'Sichere Probleme auto-fixen', um einfache Formatierungsfehler direkt korrigieren zu lassen.
- •Der Prüfer zerlegt das Dokument in Blöcke und gleicht diese mit den integrierten markdownlint- und Typografie-Regeln ab.
- •Sie erhalten einen detaillierten Bericht mit Zeilenangaben, Fehler-IDs und Hinweisen sowie den bereinigten Markdown-Code.
Anwendungsfälle
Beispiele
1. Bereinigung einer README-Datei vor dem Release
Software-Entwickler- Hintergrund
- Ein Entwickler möchte die Projektdokumentation aufräumen. Die Datei enthält unregelmäßige Listen-Symbole, überflüssige Leerzeichen am Zeilenende und Code-Blöcke ohne Sprachangabe.
- Problem
- Inkonsistente Formatierung und fehlendes Syntax-Highlighting im Markdown-Dokument.
- Verwendung
- Den Inhalt der README.md einfügen, den Regelsatz auf 'Standard' belassen und die Option 'Sichere Probleme auto-fixen' aktivieren.
- Beispielkonfiguration
-
ruleSet: "default", autoFix: true - Ergebnis
- Die Listenmarker werden vereinheitlicht, Leerzeichen am Zeilenende entfernt und der Entwickler erhält eine Warnung, dass dem Code-Block eine Sprachangabe fehlt.
2. Korrektur von Abständen in zweisprachigen Dokumenten
Technischer Redakteur- Hintergrund
- Ein Redakteur verfasst Dokumente, die sowohl chinesische Schriftzeichen als auch englische Fachbegriffe und Versionsnummern enthalten.
- Problem
- Fehlende Abstände zwischen den unterschiedlichen Zeichensätzen (z. B. '使用Python3' statt '使用 Python 3').
- Verwendung
- Den Text einfügen, den Regelsatz auf 'Standard' setzen und die Prüfung starten.
- Beispielkonfiguration
-
ruleSet: "default", autoFix: true - Ergebnis
- Das Tool fügt automatisch die korrekten Leerzeichen zwischen den chinesischen und lateinischen Zeichen ein.
Mit Samples testen
markdownVerwandte Hubs
FAQ
Welche Regeln deckt der Prüfer ab?
Er prüft 15 markdownlint-Regeln (wie MD001 für Überschriften, MD009 für Leerzeichen am Ende) und 2 chinesische Typografie-Regeln.
Was bewirkt die Option 'Sichere Probleme auto-fixen'?
Sie korrigiert automatisch unbedenkliche Fehler wie doppelte Leerzeilen, Leerzeichen am Zeilenende und inkonsistente Listenmarker.
Werden meine Überschriften-Hierarchien automatisch verändert?
Nein. Strukturelle Fehler wie übersprungene Überschriften-Ebenen werden nur gemeldet, aber nicht automatisch korrigiert.
Was ist der Unterschied zwischen den Regelsätzen?
Standard prüft alle Basisregeln, Streng fügt Zeilenlängen- und Listenpräfix-Prüfungen hinzu, und Nachsichtig ignoriert reine Stilwarnungen.
Unterstützt das Tool die Prüfung von Abständen bei gemischten Sprachen?
Ja, die Regel CN001 prüft und korrigiert fehlende Leerzeichen zwischen chinesischen Schriftzeichen und lateinischen Buchstaben oder Ziffern.