Wichtige Fakten
- Kategorie
- Entwicklung & Web
- Eingabetypen
- textarea, select
- Ausgabetyp
- text
- Sample-Abdeckung
- 4
- API verfügbar
- Yes
Überblick
Der Markdown-Link-Prüfer analysiert Ihre Markdown-Dokumente statisch auf Syntaxfehler in Links, ungültige interne Anker und nicht definierte Referenzen. Da das Tool vollständig lokal und ohne Netzwerkanfragen arbeitet, eignet es sich ideal zur schnellen Überprüfung von Dokumentationen, Readmes und Blogbeiträgen direkt im Browser.
Wann verwenden
- •Vor dem Veröffentlichen oder Committen von Markdown-Dokumentationen, um tote interne Verweise zu vermeiden.
- •Zur schnellen Überprüfung von Referenz-Links auf ungenutzte oder doppelt definierte IDs.
- •Wenn Sie Dokumente mit sensiblen Inhalten prüfen möchten, ohne dass externe HTTP-Anfragen gesendet werden.
So funktioniert es
- •Fügen Sie Ihren Markdown-Text in das Eingabefeld ein.
- •Wählen Sie die Prüfebene aus: 'Basis' für Formatfehler und defekte Anker oder 'Streng' für zusätzliche Prüfungen wie ungenutzte Referenzen.
- •Wählen Sie das gewünschte Berichtsformat (Textbericht oder JSON) aus.
- •Starten Sie die Analyse, um sofort eine Liste aller fehlerhaften Links und Anker zu erhalten.
Anwendungsfälle
Beispiele
1. Bereinigung einer README.md vor dem Release
Open-Source-Entwickler- Hintergrund
- Ein Entwickler möchte eine umfangreiche README.md für ein neues Release veröffentlichen, in der viele interne Links auf Überschriften verweisen.
- Problem
- Es ist unklar, ob alle manuell geschriebenen Anker-Links (z. B. `#installation`) exakt mit den Überschriften übereinstimmen.
- Verwendung
- Kopieren Sie den Inhalt der README.md in das Eingabefeld, wählen Sie die Prüfebene 'Basis' und das Berichtsformat 'Textbericht'.
- Beispielkonfiguration
-
checkLevel: basic, reportFormat: text - Ergebnis
- Das Tool listet sofort einen Tippfehler im Anker `#instalation` auf, der daraufhin korrigiert werden kann.
2. Strikte Validierung von Referenz-Links
Technische Redakteurin- Hintergrund
- Eine Redakteurin pflegt ein langes Handbuch im Markdown-Format, das am Ende eine Liste mit Referenz-Links (z. B. `[1]: https://example.com`) nutzt.
- Problem
- Durch häufige Bearbeitungen sind möglicherweise ungenutzte Referenzen übrig geblieben oder Links doppelt definiert worden.
- Verwendung
- Fügen Sie den Text ein, stellen Sie die Prüfebene auf 'Streng' und wählen Sie 'JSON' als Berichtsformat für die automatisierte Weiterverarbeitung.
- Beispielkonfiguration
-
checkLevel: strict, reportFormat: json - Ergebnis
- Das Tool gibt ein JSON-Array aus, das zwei ungenutzte Referenz-IDs und eine doppelte Definition präzise mit Zeilennummern benennt.
Mit Samples testen
markdownVerwandte Hubs
FAQ
Führt das Tool echte HTTP-Anfragen aus, um externe Links zu testen?
Nein, die Prüfung erfolgt rein statisch auf Formatfehler, interne Anker und Referenzen, ohne externe Server zu kontaktieren.
Was ist der Unterschied zwischen der Basis- und der strengen Prüfung?
Die Basisprüfung sucht nach Formatfehlern und defekten Ankern. Die strenge Prüfung meldet zusätzlich ungenutzte Referenzen und doppelte Anker.
Kann ich die Ergebnisse exportieren?
Ja, Sie können den Bericht wahlweise als strukturierten Text oder im JSON-Format ausgeben lassen.
Erkennt das Tool auch relative Dateipfade?
Es prüft die syntaktische Korrektheit von Pfaden und internen Ankern (#anker), kann jedoch nicht prüfen, ob lokale Dateien auf Ihrem Dateisystem existieren.
Werden meine Markdown-Daten an einen Server gesendet?
Nein, die Verarbeitung erfolgt vollständig lokal in Ihrem Browser, sodass Ihre Dokumente privat bleiben.