v0.9.8 - OpenAPI ausklappbare Operationen & Schema-Einschränkungen, LLMs-Prompt & Gruppierung, Link-Validierung & Türkische Lokalisierung

Highlights

docmd v0.9.8 führt wesentliche Verbesserungen für die API-Dokumentation mit ausklappbaren OpenAPI-Operationen und detaillierten Schema-Einschränkungen ein, ergänzt benutzerdefinierte System-Prompts und Abschnittsgruppierungen im LLMs-Plugin, behebt Sonderfälle bei der Link-Validierung, gewährleistet eine saubere Stdio-Ausgabe für MCP-JSON-RPC-Clients und bietet vollständige Lokalisierungsparität mit Unterstützung der türkischen Sprache.

  • OpenAPI-Operationen & Schema-Einschränkungen (@docmd/plugin-openapi): OpenAPI-Endpunktblöcke sind jetzt interaktiv ausklappbar für eine übersichtlichere Navigation in umfangreichen APIs (PR #255 von @w666, schließt #254). Endpunktparameter und Schemas stellen Validierungsbeschränkungen (Min/Max, Zeichenkettenlängen, Regex-Muster, Pflichtfelder) und Array-Elemente übersichtlich dar.
  • Gebündelte OpenAPI-Laufzeitabhängigkeiten: js-yaml und markdown-it wurden direkt als Laufzeitabhängigkeiten von @docmd/plugin-openapi aufgenommen (PR #255 von @w666), um Auflösungsfehler in eigenständigen Umgebungen zu vermeiden.
  • LLMs-Plugin-Prompt-Konfiguration (@docmd/plugin-llms): Einstellung eines prompt-Feldes auf oberster Ebene, das individuelle Anweisungen und Richtlinien für KI-Coding-Assistenten am Anfang von llms.txt einfügt. Dokumentationslinks in llms.txt werden nun logisch nach Abschnitten gruppiert.
  • Gehärtete Link-Validierung (@docmd/core): Die Link-Validierung entfernt nun optionale Markdown-Link-Titel ([text](url "title")) und ignoriert Links in Codeblöcken (schließt #259). Absolute /assets/-Pfade und leere Alt-Texte werden fehlerfrei aufgelöst (PR #256 von @Aryan007-dev, schließt #250 und #251).
  • Sauberes MCP-Stdout (@docmd/core): Unterdrückung des TUI-Banners auf stdout bei Ausführung von docmd mcp (PR #260 von @vishalhabib99). ANSI-Escape-Sequenzen stören nicht mehr die JSON-RPC-Protokollkommunikation mit KI-Clients wie Claude Desktop und Cursor.
  • Lokalisierungsparität (i18n) & Türkisch-Unterstützung (@docmd/ui): Vollständige türkische (tr) UI-Übersetzungen (PR #258 von @KeuqS) und README.tr.md hinzugefügt. Abgleich aller Übersetzungsschlüssel über Englisch, Französisch, Hindi, Japanisch, Koreanisch, Russisch, Türkisch, Deutsch, Spanisch und Chinesisch für Default- und Summer-Templates.
  • Verfeinerte Bildunterschriften (@docmd/ui): Bildunterschriften werden nun als zentrierter, eleganter kursiver Text unter Abbildungen mit fit-content-Layout gerendert (PR #253 von @w666, schließt #252).
  • Sicherheits- & Abhängigkeitsaktualisierungen: Aktualisierung der NPM-Abhängigkeitsgruppe (PR #257), katex und sharp auf gepatchte Versionen überschrieben, interne Ticket-Referenzen aus Quellkommentaren entfernt und Workspace-Abhängigkeiten aktualisiert.

OpenAPI: Ausklappbare Operationen & Schema-Einschränkungen (@docmd/plugin-openapi)

Beigetragen von @w666 in PR #255 (schließt Issue #254):

  • Ausklappbare Endpunktblöcke: API-Operationen lassen sich nun interaktiv auf- und zuklappen, begleitet von Inhaltsverzeichnis-Überschriften (TOC) für schnelles Scrollen und Navigieren.
  • Schema-Validierungsbeschränkungen: Tabellen für Anfrage- und Antwortschemas zeigen Validierungsbeschränkungen an, darunter:
    • Grenzen der Zeichenkettenlänge (minLength, maxLength)
    • Numerische Bereiche (minimum, maximum, exclusiveMinimum, exclusiveMaximum)
    • Reguläre Ausdrücke (pattern)
    • Eindeutige visuelle Badges für required-Felder
    • Array-Elementtypen und Schemaspezifikationen
  • Referenzierte Request-Bodies: Verbesserte Dereferenzierung von $ref-Zeigern innerhalb von Request-Bodies und komplexen Schemata.
  • Laufzeitabhängigkeiten: markdown-it und js-yaml als direkte Abhängigkeiten gebündelt.

LLMs-Plugin — Prompt-Konfiguration & Abschnittsgruppierung (@docmd/plugin-llms)

  • Benutzerdefinierter System-Prompt: Konfigurieren Sie einen prompt-String in Ihrer plugins.llms-Konfiguration. Dieser Prompt wird direkt am Anfang der generierten Datei /llms.txt eingefügt.
  • Abschnittsgruppierung: Dokumentations-URLs in llms.txt sind jetzt unter beschreibenden Markdown-Überschriften strukturiert angeordnet.

Der Befehl docmd validate und die MCP-Validierungswerkzeuge erhielten wichtige Korrekturen:

  • Markdown-Link-Titel & Codeblöcke (Issue #259): Titelattribute (z. B. [Übersicht](/getting-started "Startanleitung")) werden vor der Pfadauflösung abgeschnitten. Links innerhalb von Codeblöcken mit drei Backticks oder Tilden werden beim Token-Parsing ignoriert, wodurch Fehlalarme bei Beispielcode ausgeschlossen werden.
  • Leere Alt-Texte & Asset-Pfade (PR #256 von @Aryan007-dev, schließt #250, #251): Regex-Muster erkennen Bilder mit leerem Alt-Text (![](pfad)), und absolute /assets/-Pfade werden korrekt relativ zum Projektstamm aufgelöst.
  • Exclude-Muster: config.exclude-Regeln werden nun direkt an validateLinks übergeben.

Sauberes MCP-Stdout für JSON-RPC-Protokoll (@docmd/core)

Beigetragen von @vishalhabib99 in PR #260:

  • 'mcp' wurde zur Banner-Unterdrückungsliste in packages/core/src/bin/docmd.ts hinzugefügt.
  • Das dekorative Startbanner wird bei Ausführung des MCP-Servers auf stdout weggelassen, wodurch JSON-Parsing-Fehler bei externen MCP-Clients wie Claude Desktop und Cursor vermieden werden.

Lokalisierungsparität (i18n) & Türkisch-Unterstützung (@docmd/ui)

  • Türkische (tr) Benutzeroberfläche (PR #258 von @KeuqS): Vollständige türkische Übersetzungen (tr.json) für alle Bedienelemente.
  • Türkische Dokumentation: README.tr.md hinzugefügt und Türkisch in den Sprachauswahlindex aller Repository-READMEs aufgenommen.
  • Übersetzungsparität: Harmonisierung aller Übersetzungsschlüssel über alle 10 unterstützten Sprachen hinweg.
  • Template-Parität: Sowohl default- als auch summer-Templates verwenden konsistent lokalisierte Schlüssel für Themes, Fokusmodus und Kopieraktionen.

UI-Verfeinerungen & Bildunterschriften-Design (@docmd/ui)

Beigetragen von @w666 in PR #253 (schließt Issue #252):

  • Die bisherigen Bildunterschriftsboxen mit vollflächigem Hintergrund wurden durch ein schlankes, modernes Design ersetzt.
  • Bildunterschriften erscheinen nun in fit-content-Breite, dezent kursiv, zentriert ausgerichtet und mit sanftem Farbkontrast.

Mitwirkende & Pull Requests

Besonderer Dank gilt den Mitgliedern der Community für ihre Beiträge zu v0.9.8:

  • @w666 für PR #255 (OpenAPI ausklappbare Operationen, Schema-Einschränkungen & Laufzeitabhängigkeiten, schließt #254) und PR #253 (zentrierte kursive Bildunterschriften, schließt #252).
  • @Aryan007-dev für PR #256 (Link-Validierung bei leeren Alt-Texten & /assets/ Pfaden, schließt #250 und #251).
  • @KeuqS für PR #258 (Türkischer UI-Übersetzungskatalog).
  • @vishalhabib99 für PR #260 (Banner-Unterdrückung auf stdout für docmd mcp).

Ausblick auf 0.9.9

  • Paketintegritätsprüfung nach Vorab-Batch-Installationen.
  • Erweiterte .gitignore-Muster einschließlich Negation (!) und verschachtelten Verzeichnis-Ignore-Dateien.
  • Weitere Leistungsoptimierungen bei der mehrsprachigen Such-Indexierung.