Frontmatter 驗證
檢查必要欄位，例如 title 與 sidebar.order。
Splash 頁面必須包含 hero 欄位與
template: splash。
f5xc-docs-tools
f5xc-docs-tools 插件可驗證 f5-sales-demo 文件管線的 MDX 內容檔案。它能在進入 CI 之前捕捉常見的建置中斷問題，包括裸露的 JSX 字元、無效的匯入、損壞的圖片參照以及不完整的 frontmatter。
v1.1.2 Productivity/plugin install f5xc-docs-tools@f5-sales-demo-marketplacemdx-content-reviewer
Section titled “mdx-content-reviewer”當 Claude 偵測到您正在 f5-sales-demo 內容儲存庫中處理 MDX 檔案時，此技能會自動啟用。它會執行七項驗證檢查：
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
Section titled “/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
元件快速參考
Section titled “元件快速參考”| 元件 | 必要 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 陷阱
Section titled “MDX 陷阱”插件捕捉的常見問題：
| 陷阱 | 問題 | 修正方式 |
|---|---|---|
裸露的 < | MDX 將其解讀為 JSX 標籤 | 使用 &lt;、行內程式碼，或改寫句子 |
未逸出的 \{ \} | MDX 將其視為 JSX 運算式 | 使用行內程式碼、以 \ 逸出，或使用程式碼區塊 |
| 檔案名稱中的大括號 | Astro 無法處理該檔案 | 切勿在 .mdx 檔案名稱中使用 \{ 或 \} |