Markdown-Linter

Prüft Markdown auf Stilprobleme: Überschriftenebenen, Code-Zäune, Listenkonsistenz und mehr (regelbasiert, ohne Abhängigkeiten)

Wichtige Fakten

Kategorie
Entwicklung & Web
Eingabetypen
textarea, select
Ausgabetyp
text
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der Markdown-Linter ist ein schnelles, regelbasiertes Werkzeug zur Überprüfung Ihrer Markdown-Dateien auf Stilprobleme wie inkonsistente Überschriftenebenen, fehlerhafte Code-Zäune oder unregelmäßige Listenstrukturen, ganz ohne externe Abhängigkeiten.

Wann verwenden

  • Vor dem Veröffentlichen von Dokumentationen oder Blogbeiträgen, um Formatierungsfehler zu vermeiden.
  • Zur Durchsetzung einheitlicher Formatierungsstandards in kollaborativen Git-Repositories.
  • Beim Bereinigen von automatisch generierten oder konvertierten Markdown-Dateien.

So funktioniert es

  • Fügen Sie Ihren Markdown-Text in das Eingabefeld für die Markdown-Eingabe ein.
  • Wählen Sie den gewünschten Regelsatz aus den Optionen Standard, Entspannt oder Streng.
  • Bestimmen Sie das Berichtsformat als Textbericht oder JSON und starten Sie die Prüfung, um Stilprobleme sofort anzuzeigen.

Anwendungsfälle

Validierung von README-Dateien in Softwareprojekten vor dem Commit.
Qualitätssicherung für technische Redakteure bei der Erstellung von Handbüchern.
Automatisierte Strukturprüfung von Markdown-Exporten aus Content-Management-Systemen.

Beispiele

1. Strukturprüfung einer README.md

Software-Entwickler
Hintergrund
Ein Entwickler möchte sicherstellen, dass die Projektdokumentation vor dem Release keine fehlerhaften Überschriften oder unvollständigen Code-Blöcke enthält.
Problem
Inkonsistente Überschriftenhierarchien und nicht geschlossene Code-Zäune erschweren das Lesen.
Verwendung
Kopieren Sie den Inhalt der README.md in das Eingabefeld, wählen Sie den Regelsatz 'Standard' und das Berichtsformat 'Textbericht'.
Beispielkonfiguration
Regelsatz: standard, Berichtsformat: text
Ergebnis
Der Linter listet die genauen Zeilennummern mit den fehlerhaften Überschriftensprüngen und offenen Code-Zäunen auf.

2. Strikte Stilprüfung für technische Dokumentation

Technische Redakteurin
Hintergrund
Für ein offizielles Produkthandbuch müssen extrem strenge Formatierungsregeln eingehalten werden, um ein einheitliches PDF-Layout zu garantieren.
Problem
Unterschiedliche Listen-Aufzählungszeichen und unregelmäßige Leerzeilen stören das Rendering.
Verwendung
Fügen Sie das Kapitel in das Textfeld ein, wählen Sie den Regelsatz 'Streng' und das Berichtsformat 'JSON' für eine detaillierte Analyse.
Beispielkonfiguration
Regelsatz: strict, Berichtsformat: json
Ergebnis
Ein strukturiertes JSON-Dokument wird ausgegeben, das alle Abweichungen von den strengen Formatierungsregeln präzise aufzeigt.

Mit Samples testen

markdown

Verwandte Hubs

FAQ

Welche Regeln prüft der Markdown-Linter?

Er prüft Überschriftenebenen, Code-Zäune, Listenkonsistenz und allgemeine Formatierungsfehler.

Was bewirkt der Regelsatz 'Streng'?

Er wendet strengere Richtlinien für Einrückungen, Leerzeilen und Überschriftenstrukturen an.

Kann ich die Fehlerberichte exportieren?

Ja, Sie können den Bericht im JSON-Format ausgeben lassen, um ihn maschinell weiterzuverarbeiten.

Benötigt das Tool eine Internetverbindung?

Nein, die Validierung erfolgt direkt lokal im Browser über eine regelbasierte Engine ohne externe Abhängigkeiten.

Werden meine Markdown-Inhalte auf Servern gespeichert?

Nein, die Verarbeitung erfolgt vollständig lokal in Ihrem Browser, sodass Ihre Daten privat bleiben.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/markdown-linter

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
markdownInput textarea Ja -
ruleSet select Nein -
reportFormat select Nein -

Antwortformat

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
Text: Text

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu:

{
  "mcpServers": {
    "elysiatools-markdown-linter": {
      "name": "markdown-linter",
      "description": "Prüft Markdown auf Stilprobleme: Überschriftenebenen, Code-Zäune, Listenkonsistenz und mehr (regelbasiert, ohne Abhängigkeiten)",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=markdown-linter",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]