Frontmatter 驗證
檢查必填欄位，例如 title 和 sidebar.order。
啟動頁面必須包含 hero 欄位和
template: splash。
f5xc-docs-tools
f5xc-docs-tools 外掛程式會驗證 f5-sales-demo 文件流程中的 MDX 內容檔案。它能在問題進入 CI 之前，捕捉常見的建置中斷問題， 包括裸露的 JSX 字元、無效的匯入、損壞的圖片參照以及不完整的 frontmatter。
v1.1.2 生產力/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 中使用的變數
是否有對應的匯出。
範圍界定行為
Section titled “範圍界定行為”此技能會智慧地界定其檢查範圍：
- 如果
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 檔名中使用 \{ 或 \} |