f5xc-docs-tools

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

v1.1.2 Productivity

インストール

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

スキル

mdx-content-reviewer

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

フロントマター検証

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

MDX 構文の落とし穴

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

インポート検証

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

コンポーネント属性

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

画像参照

参照された画像が docs/images/ ディレクトリに存在することを確認します。

構造チェック

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

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

Code コンポーネントの code プロパティで使用される変数に対応するエクスポートが存在することを確認します。

スコープの動作

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

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

出力形式

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

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

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

コマンド

/review-mdx

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

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

引数：

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

例：

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

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

# グロブに一致するファイルをレビュー
/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

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

コンポーネント	必須プロパティ	任意プロパティ
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` ファイル名に `\{` や `\}` を使用しない