f5xc-docs-tools

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

v1.1.2 Produktivität

Installation

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

Skills

mdx-content-reviewer

Dieser Skill wird automatisch aktiviert, wenn Claude erkennt, dass Sie mit MDX-Dateien in einem f5-sales-demo-Content- Repository arbeiten. Er 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 Imports gegen eine Allowlist von Starlight- Built-in- und f5-sales-demo-Theme-Komponenten.

Komponenten-Attribute

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 existiert und Bildverzeichnisse keine verirrten MDX-Dateien enthalten.

Exports und Codeblöcke

Überprüft, ob Variablen, die in code-Props der Code-Komponente verwendet werden, passende Exports haben.

Scoping-Verhalten

Der Skill begrenzt seine Überprüfung intelligent:

Wenn es nicht committete oder gestagete Änderungen an docs/**/*.mdx-Dateien gibt, werden nur diese Dateien überprüft
Andernfalls werden alle docs/**/*.mdx-Dateien überprüft

Ausgabeformat

Befunde werden nach Schweregrad gruppiert:

ERROR — wird den Build brechen; 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 den Skill mdx-content-reviewer auf Abruf aus.

Argumente:

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

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 überprüfen, die einem Glob-Muster entsprechen
/f5xc-docs-tools:review-mdx docs/guides/*.mdx

Ausgabe: Eine Zusammenfassungszeile am Ende zeigt die Gesamtzahl der überprüften Dateien und die Anzahl der Befunde nach Schweregrad.

Erlaubte Imports

Das Plugin validiert Imports gegen diese Quellen:

Starlight-Built-in-Komponenten (@astrojs/starlight/components):

Aside Badge Card CardGrid Code FileTree Icon LinkCard Steps TabItem Tabs

f5-sales-demo-Theme-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 (Theme)	`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 es als JSX-Tag	Verwenden Sie `&lt;`, Inline-Code oder formulieren Sie um
Nicht-escaptes `\{` `\}`	MDX behandelt es als JSX-Ausdruck	Verwenden Sie Inline-Code, escapen Sie mit `\` oder verwenden Sie einen Codeblock
Klammern in Dateinamen	Astro kann die Datei nicht verarbeiten	Verwenden Sie niemals `\{` oder `\}` in `.mdx`-Dateinamen