f5xc-docs-tools

f5xc-docs-tools プラグインは、f5-sales-demo ドキュメントパイプライン向けの MDX コンテンツファイルを検証します。ベア JSX 文字、無効なインポート、壊れた画像参照、不完全なフロントマターなど、ビルドを破壊する一般的な問題を CI に到達する前にキャッチします。

v1.1.2 生産性

インストール

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

スキル

mdx-content-reviewer

このスキルは、f5-sales-demo コンテンツリポジトリで MDX ファイルを操作していることを Claude が検出すると自動的にアクティブになります。7 つの検証チェックを実行します：

フロントマター検証

title や sidebar.order などの必須フィールドをチェックします。スプラッシュページには hero フィールドと template: splash が含まれている必要があります。

MDX 構文の落とし穴

MDX パースを破壊するベア < 文字やエスケープされていない \{ \} ブレースを検出します。

インポート検証

Starlight 組み込みおよび f5-sales-demo テーマコンポーネントの許可リストに対してインポートを検証します。

コンポーネント属性

Screenshot、Aside、Code、LinkCard、Card、Badge などのコンポーネントの必須 props をチェックします。

画像参照

参照された画像が docs/images/ ディレクトリに存在するかを検証します。

構造チェック

docs/index.mdx が存在することと、画像ディレクトリに不要な MDX ファイルが含まれていないことを確認します。

エクスポートとコードブロック

Code コンポーネントの code props で使用される変数に対応するエクスポートがあるかを検証します。

スコープ動作

このスキルはレビュー範囲をインテリジェントにスコープします：

docs/**/*.mdx ファイルにコミットされていない変更やステージされた変更がある場合、それらのファイルのみがレビューされます
それ以外の場合、すべての docs/**/*.mdx ファイルがレビューされます

出力形式

検出結果は重大度別にグループ化されます：

ERROR — ビルドを破壊します。マージ前に修正が必要です
WARNING — 対処すべき可能性の高い問題です
INFO — 提案とベストプラクティスです

各検出結果には、ファイルパス、行番号、および問題の説明が含まれます。

コマンド

/review-mdx

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

mdx-content-reviewer スキルをオンデマンドで実行します。

引数：

引数	必須	説明
`path-or-glob`	いいえ	レビュー範囲を指定するファイルパスまたは glob パターン。デフォルトはすべての `docs/*/.mdx` ファイルです。

例：

# docs/ 内のすべての MDX ファイルをレビュー
/f5xc-docs-tools:review-mdx

# 特定のファイルをレビュー
/f5xc-docs-tools:review-mdx docs/getting-started.mdx

# glob に一致するファイルをレビュー
/f5xc-docs-tools:review-mdx docs/guides/*.mdx

出力： 最後にサマリー行が表示され、レビューされたファイルの総数と重大度別の検出件数が報告されます。

許可されたインポート

プラグインは以下のソースに対してインポートを検証します：

Starlight 組み込みコンポーネント (@astrojs/starlight/components)：

Aside Badge Card CardGrid Code FileTree Icon LinkCard Steps TabItem Tabs

f5-sales-demo テーマコンポーネント (@f5-sales-demo/docs-theme/components/)：

Banner Icon LinkCard Screenshot

コンポーネントクイックリファレンス

コンポーネント	必須 Props	オプション Props
Screenshot	`alt` + `light` または `dark` のいずれか	—
Aside	`type`	`title`
Code	`code`, `lang`	`title`, `frame`, `mark`, `ins`, `del`
LinkCard (テーマ)	`title`, `href`	`description`, `icon`
Card	`title`	`icon`
Badge	`text`	`variant`
Steps	—	—
Tabs / TabItem	TabItem: `label`	—
CardGrid	—	—
FileTree	—	—

MDX の落とし穴

プラグインがキャッチする一般的な問題：

落とし穴	問題	修正方法
ベア `<`	MDX が JSX タグとして解釈する	`&lt;`、インラインコード、または表現の変更を使用
エスケープされていない `\{` `\}`	MDX が JSX 式として扱う	インラインコードを使用、`\` でエスケープ、またはコードブロックを使用
ファイル名のブレース	Astro がファイルを処理できない	`.mdx` ファイル名に `\{` や `\}` を使用しない