Components
GitBook 에디터의 자주 쓰이는 컴포넌트들. 모두 라이트/다크 양쪽 동작 + 마크다운에서 사용 가능.
Callouts
참고
정보용 callout. 본문 흐름을 끊지 않는 보조 설명.
주의
이 코드는 production에 바로 쓰지 마. 에러 핸들링이 빠져 있어.
위험
rm -rf는 복구 불가능. 항상 경로를 두 번 확인.
완료
모든 테스트 통과. 배포 준비 끝.
Tabs
curl -X POST https://api.example.com/users \
-H "Authorization: Bearer $TOKEN" \
-d '{"name": "kw"}'const res = await fetch('/api/users', {
method: 'POST',
headers: { 'Authorization': `Bearer ${token}` },
body: JSON.stringify({ name: 'kw' })
});import requests
requests.post(
"https://api.example.com/users",
json={"name": "kw"},
)Expandable
Stepper
-
저장소 클론
git clone https://github.com/... -
의존성 설치
npm install -
개발 서버 실행
npm run dev— 기본 포트 4321 -
배포
main 브랜치 푸시 → GitHub Actions가 자동 빌드 + Pages 배포
Cards
API method badges
- GET
/api/users/{id}— 유저 조회 - POST
/api/users— 유저 생성 - PUT
/api/users/{id}— 전체 갱신 - PATCH
/api/users/{id}— 부분 갱신 - DELETE
/api/users/{id}— 삭제
Embed
Code blocks (Shiki 듀얼 테마)
마크다운 코드 펜스로 작성하면 Shiki가 자동 처리. 라이트/다크 양쪽에서 GitHub 팔레트로 렌더링.
function fibonacci(n) {
if (n < 2) return n;
return fibonacci(n - 1) + fibonacci(n - 2);
}
(위는 정적 데모 — 실제 마크다운(.md) 파일의 펜스 코드 블록은 Shiki가 토큰별로 색을 입혀줘.)
Book Quote (책 인용)
책 리뷰/인용에 쓰는 특별 인용구. 노란 라벨이 위에 떠 있고 amber 톤 박스 — 본문 흐름에서 시각적으로 분명히 구분돼.
📖 BOOK
좋은 책은 처음 읽을 때는 새 친구를 얻은 것 같고, 이미 읽은 책을 다시 읽을 때는 옛 친구를 만난 것 같다.
Keyboard (kbd)
키캡 스타일. 둥근 알약형 + 두꺼운 보더 + 모노스페이스로 키 누른 느낌 살림.
검색: ⌘ + K, 도움말: ⌘ + /, 테마 토글: ⌘ + Shift + D
Mermaid 다이어그램
플로우차트/시퀀스/ER 다이어그램을 마크다운에 직접 그리기. 페이지에 mermaid 블록이 있을 때만 라이브러리 lazy-load.
사용법: 마크다운/HTML 안에 <pre class="mermaid">...</pre> 형태로 작성.
graph LR Client[Client] --> Nginx[Nginx] Nginx --> App[FastAPI] App --> DB[(PostgreSQL)] App --> Cache[(Redis)]
시퀀스 다이어그램도:
sequenceDiagram participant U as User participant N as Nginx participant A as App U->>N: GET /api/users N->>A: forward A->>A: process A-->>N: 200 OK N-->>U: response