본문으로 건너뛰기

콘텐츠 스타일 가이드

모든 레벨

일관성이야말로 레퍼런스를 신뢰할 만하게 느끼도록 만드는 요소입니다. 이를 따르면 여러분의 PR은 리뷰를 매끄럽게 통과합니다.

어조​

  • 명확하고 직접적으로. 짧은 문장. 핵심을 먼저 말하세요.
  • 친근하되 군더더기 없이. "오늘날 빠르게 변화하는 세상에서" 같은 표현은 빼세요. 독자의 시간을 존중하세요.
  • 소신을 가지되 정직하게. 권장하는 한 가지 방법을 먼저 제시한 뒤, 대안과 트레이드오프를 언급하세요.
  • 이론보다 예시. 스니펫이나 구체적인 사례를 보여주세요. 설명만 하지 마세요.
  • 미국식 영어.

페이지의 구조​

---
sidebar_position: 2
title: "Your Page Title"
description: "One sentence for search and previews."
---

<LevelBadge level="beginner" />

A one or two sentence intro that states what the reader will get.

## Sections with ## headings
...

## Next
- 2–4 links to related pages
  • 레벨 배지로 시작하세요(beginner | intermediate | advanced | all). 컴포넌트는 전역이므로 — import하지 마세요.
  • 관련 페이지로 향하는 2~4개의 내부 링크가 담긴 "Next" / "Related" 목록으로 끝맺으세요.
  • 강조를 위해 안내 박스(:::tip, :::warning, :::note, :::info)를 절제해서 사용하세요.

두 가지 절대 규칙​

:::warning 타협 불가

  1. 변동성 있는 사실은 출처를 인용하세요. 모델 이름, 가격, 한도, 정확한 플래그, 베타 기능 → 공식 출처를 링크하고 <VerifyNote lastVerified="YYYY-MM-DD" source="…">를 추가하세요. 모델 관련 사실은 절대 하드코딩하지 마세요 — 모델 표로 링크하세요. 자세히: 사실 검증.
  2. 지어내지 마세요. 만들어낸 통계, 인용문, API, 기능은 안 됩니다. 확실하지 않다면 그렇다고 말하거나 [verify]로 표시하세요. :::

의견 대 공식 문서​

  • 우리는 소신이 있습니다 — 그것이 가치입니다. 단순히 나열하지 말고 권장하세요.
  • 하지만 공식 문서가 진실의 원천입니다. 공식 문서를 따르고, 링크하며, 말없이 그것에 모순되는 내용을 쓰지 마세요.

MDX 함정​

  • 본문의 중괄호 {like this}는 MDX에서 코드로 파싱됩니다 — 백틱이나 코드 펜스에 넣거나, 예시에서는 [brackets]를 사용하세요.
  • 로컬에서 테스트하세요: npm run build가 통과해야 합니다(깨진 링크가 있으면 실패합니다).

다음 단계​