프론트매터 유효성 검사
title 및 sidebar.order와 같은 필수 필드를 확인합니다.
스플래시 페이지에는 hero 필드와
template: splash가 포함되어야 합니다.
f5xc-docs-tools
f5xc-docs-tools 플러그인은 f5-sales-demo 문서 파이프라인의 MDX 콘텐츠 파일을 유효성 검사합니다. CI에 도달하기 전에 빌드를 중단시키는 일반적인 문제를 사전에 감지하며, 여기에는 노출된 JSX 문자, 잘못된 임포트, 손상된 이미지 참조, 불완전한 프론트매터 등이 포함됩니다.
v1.1.2 Productivity/plugin install f5xc-docs-tools@f5-sales-demo-marketplacemdx-content-reviewer
섹션 제목: “mdx-content-reviewer”이 스킬은 Claude가 f5-sales-demo 콘텐츠 저장소에서 MDX 파일 작업을 감지하면 자동으로 활성화됩니다. 7가지 유효성 검사를 수행합니다:
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
섹션 제목: “/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
구성 요소 빠른 참조
섹션 제목: “구성 요소 빠른 참조”| 구성 요소 | 필수 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 함정”플러그인이 감지하는 일반적인 문제:
| 함정 | 문제 | 해결 방법 |
|---|---|---|
노출된 < | MDX가 JSX 태그로 해석 | &lt;, 인라인 코드 사용 또는 표현 수정 |
이스케이프되지 않은 \{ \} | MDX가 JSX 표현식으로 처리 | 인라인 코드 사용, \로 이스케이프 또는 코드 블록 사용 |
| 파일명의 중괄호 | Astro가 파일을 처리할 수 없음 | .mdx 파일명에 \{ 또는 \} 사용 금지 |