f5xc-docs-tools

Das f5xc-docs-tools-Plugin validiert MDX-Inhaltsdateien für die f5-sales-demo-Dokumentationspipeline. Es erkennt häufige build-brechende Probleme, bevor sie CI erreichen, darunter nackte JSX- Zeichen, ungültige Importe, fehlerhafte Bildreferenzen und unvollständiges Frontmatter.

v1.1.2 Produktivität

Installation

/plugin install f5xc-docs-tools@f5-sales-demo-marketplace

Funktionen

mdx-content-reviewer

Diese Funktion wird automatisch aktiviert, wenn Claude erkennt, dass Sie mit MDX-Dateien in einem f5-sales-demo-Inhalts-Repository arbeiten. Sie führt sieben Validierungsprüfungen durch:

Frontmatter-Validierung

Prüft erforderliche Felder wie title und sidebar.order. Splash-Seiten müssen hero-Felder und template: splash enthalten.

MDX-Syntaxfallen

Erkennt nackte <-Zeichen und nicht escapte \{ \}- Klammern, die das MDX-Parsing unterbrechen.

Import-Validierung

Validiert Importe anhand einer Zulassungsliste von Starlight- integrierten und f5-sales-demo-Thema-Komponenten.

Komponentenattribute

Prüft erforderliche Props für Komponenten wie Screenshot, Aside, Code, LinkCard, Card und Badge.

Bildreferenzen

Überprüft, ob referenzierte Bilder im Verzeichnis docs/images/ vorhanden sind.

Strukturprüfungen

Stellt sicher, dass docs/index.mdx vorhanden ist und Bildverzeichnisse keine fehlplatzierten MDX-Dateien enthalten.

Exporte und Code-Blöcke

Überprüft, ob Variablen, die in Code-Komponenten-code- Props verwendet werden, übereinstimmende Exporte besitzen.

Geltungsbereichsverhalten

Die Funktion begrenzt ihre Überprüfung intelligent:

Wenn nicht committete oder bereitgestellte Änderungen an docs/**/*.mdx- Dateien vorhanden sind, werden nur diese Dateien überprüft
Andernfalls werden alle docs/**/*.mdx-Dateien überprüft

Ausgabeformat

Befunde werden nach Schweregrad gruppiert:

ERROR — wird den Build unterbrechen; muss vor dem Mergen behoben werden
WARNING — wahrscheinliche Probleme, die behoben werden sollten
INFO — Vorschläge und Best Practices

Jeder Befund enthält den Dateipfad, die Zeilennummer und eine Beschreibung des Problems.

Befehle

/review-mdx

/f5xc-docs-tools:review-mdx [path-or-glob]

Führt die mdx-content-reviewer-Funktion bei Bedarf aus.

Argumente:

Argument	Erforderlich	Beschreibung
`path-or-glob`	Nein	Dateipfad oder Glob-Muster zur Begrenzung der Überprüfung. Standardmäßig alle `docs/*/.mdx`-Dateien.

Beispiele:

# Alle MDX-Dateien in docs/ überprüfen
/f5xc-docs-tools:review-mdx

# Eine bestimmte Datei überprüfen
/f5xc-docs-tools:review-mdx docs/getting-started.mdx

# Dateien anhand eines Glob-Musters überprüfen
/f5xc-docs-tools:review-mdx docs/guides/*.mdx

Ausgabe: Eine Zusammenfassungszeile am Ende gibt die Gesamtanzahl der überprüften Dateien und die Befundanzahl nach Schweregrad aus.

Erlaubte Importe

Das Plugin validiert Importe anhand dieser Quellen:

Starlight integrierte Komponenten (@astrojs/starlight/components):

Aside Badge Card CardGrid Code FileTree Icon LinkCard Steps TabItem Tabs

f5-sales-demo-Dokumentationsthema-Komponenten (@f5-sales-demo/docs-theme/components/):

Banner Icon LinkCard Screenshot

Komponenten-Kurzreferenz

Komponente	Erforderliche Props	Optionale Props
Screenshot	`alt` + mindestens eines von `light` oder `dark`	—
Aside	`type`	`title`
Code	`code`, `lang`	`title`, `frame`, `mark`, `ins`, `del`
LinkCard (Thema)	`title`, `href`	`description`, `icon`
Card	`title`	`icon`
Badge	`text`	`variant`
Steps	—	—
Tabs / TabItem	TabItem: `label`	—
CardGrid	—	—
FileTree	—	—

MDX-Fallstricke

Häufige Probleme, die das Plugin erkennt:

Fallstrick	Problem	Lösung
Nacktes `<`	MDX interpretiert als JSX-Tag	`&lt;`, Inline-Code verwenden oder umformulieren
Nicht escapte `\{` `\}`	MDX behandelt als JSX-Ausdruck	Inline-Code verwenden, mit `\` escapen oder Code-Block verwenden
Geschweifte Klammern in Dateinamen	Astro kann die Datei nicht verarbeiten	Niemals `\{` oder `\}` in `.mdx`-Dateinamen verwenden