작성 가이드
본 사이트 문서는 Markdown으로 작성되며, Frontmatter, 힌트 블록, 코드 하이라이팅, 수학 공식 등 확장 문법을 지원합니다.
Frontmatter
파일 상단에서 YAML로 페이지 메타 정보를 선언합니다:
md
---
title: 페이지 제목
description: 페이지 설명(SEO용)
tags:
- 가이드
- Markdown
---
# 본문 제목자주 쓰는 필드:
| 필드 | 설명 |
|---|---|
title | 페이지 제목으로, 내비게이션 바 표시를 덮어씁니다 |
description | 페이지 설명으로, 검색 엔진과 공유 카드에 사용됩니다 |
tags | 페이지 태그 |
layout | 페이지 레이아웃, 기본값 doc, 홈페이지는 home |
outline | 오른쪽 목차 표시 여부 |
힌트 블록
md
:::: tip 힌트
이것은 힌트 메시지입니다.
::::
:::: warning 주의
이것은 경고 메시지입니다.
::::
:::: danger 위험
이것은 위험 메시지입니다.
::::
:::: info 설명
이것은 일반 설명입니다.
::::미리보기:
힌트
이것은 힌트 메시지입니다.
주의
이것은 경고 메시지입니다.
위험
이것은 위험 메시지입니다.
설명
이것은 일반 설명입니다.
코드 블록
js, ts, bash, python, json, sql 등 흔한 언어의 문법 하이라이팅을 지원하며, 줄 번호 표시와 특정 줄 하이라이팅도 지원합니다:
md
```js {2,4-5}
function greet(name) {
const message = `Hello, ${name}!` // 하이라이트 줄
console.log(message)
return message
}
```js
function greet(name) {
const message = `Hello, ${name}!` // 하이라이트 줄
console.log(message)
return message
}수학 공식
KaTeX로 수학 공식을 렌더링합니다:
md
인라인 공식 $E = mc^2$
블록 공식:
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$표
md
| 메서드 | 경로 | 설명 |
| --- | --- | --- |
| GET | `/api/users` | 사용자 목록 조회 |
| POST | `/api/users` | 사용자 생성 |
| DELETE | `/api/users/:id` | 사용자 삭제 |이미지와 링크
md
[빠른 시작으로 이동](./getting-started)컴포넌트 확장
VitePress는 Markdown에서 Vue 컴포넌트를 직접 사용할 수 있어, 복잡한 인터랙션(차트, 데모, Tab 등)을 컴포넌트로 캡슐화하여 재사용할 수 있습니다.
작성 제안
- 각 문서는 하나의 주제에 집중하고, 명확한 제목 계층(
#→##→###)을 사용하세요; - 코드 예시는 반드시 바로 실행 가능해야 하며 필요한 주석을 포함하세요;
- 힌트 블록으로 주의 사항과 경계 상황을 강조하세요;
- 관련 문서 간에는 상대 링크로 서로 이동하세요.