문서 작성 가이드•
GitHub 스타일 Alerts (Callouts) 사용 가이드
이 프로젝트는 마크다운 렌더러 내에서 GitHub 스타일의 Alerts (Callouts) 문법을 지원합니다. 중요한 정보, 팁, 경고 등을 시각적으로 강조할 때 사용하세요.
기본 문법
인용구(>) 블록의 첫 번째 줄에 [!TYPE] 키워드를 작성합니다.
> [!NOTE]
> 유용한 정보입니다.
> [!TIP]
> 팁이나 제안 사항입니다.
> [!IMPORTANT]
> 중요한 내용입니다.
> [!WARNING]
> 주의가 필요한 사항입니다.
> [!CAUTION]
> 위험하거나 중대한 경고입니다.
실제 사용 예시
NOTE
이 프로젝트의 모든 문서는 최신 버전(v2.0)을 기준으로 작성되었습니다.
TIP
에디터에서 Ctrl + Space를 누르면 사용 가능한 공통 함수 목록을 확인할 수 있습니다.
IMPORTANT
코드를 커밋하기 전에 반드시 로컬 환경에서 빌드 성공 여부를 확인해야 합니다.
WARNING
강제 푸시(git push -f)는 동료의 작업 내용을 덮어쓸 수 있으므로 신중하게 사용하세요.
CAUTION
운영 서버 환경 설정 파일을 수정할 때는 데이터 유실의 위험이 있으므로 반드시 백업을 먼저 생성하세요.
지원하는 타입
| 타입 | 키워드 | 색상 | 용도 |
|---|---|---|---|
| Note | [!NOTE] |
Blue | 사용자가 내용을 훑어볼 때도 놓치지 않아야 할 유용한 정보 |
| Tip | [!TIP] |
Green | 작업을 더 쉽고 효율적으로 할 수 있는 팁이나 제안 |
| Important | [!IMPORTANT] |
Purple | 성공적인 결과를 위해 꼭 확인해야 할 핵심 정보 |
| Warning | [!WARNING] |
Orange | 사용자가 즉시 주의를 기울여야 할 주의 사항 |
| Caution | [!CAUTION] |
Red | 잘못될 경우 부정적인 결과가 발생할 수 있는 중대한 경고 |
특징
- 다크 모드 지원: 시스템 설정에 따라 라이트 모드와 다크 모드에 최적화된 색상으로 자동 변경됩니다.
- 아이콘 포함: 각 타입에 맞는 아이콘이 자동으로 추가됩니다.
- 표준 호환성: 확장 문법을 지원하지 않는 렌더러에서는 일반 인용구로 표시되어 호환성이 유지됩니다.
다중 라인 지원
본문은 여러 줄로 작성할 수 있으며, 일반적인 마크다운 문법(굵게, 링크 등)을 그대로 사용할 수 있습니다.
> [!TIP]
> **단축키**를 사용하면 더 빠릅니다.
> - `Ctrl + S`: 저장
> - `Ctrl + P`: 인쇄
실제 사용 예시:
TIP
단축키를 사용하면 더 빠릅니다.
Ctrl + S: 저장Ctrl + P: 인쇄
AI 작성을 위한 프롬프트 가이드
AI에게 문서 작성을 요청할 때 아래 프롬프트를 포함하면 해당 스타일의 Alerts를 활용해 줍니다.
프롬프트 예시: “문서 작성 시 중요한 정보는 GitHub 스타일의 Alerts 문법(
> [!NOTE],> [!TIP],> [!IMPORTANT],> [!WARNING],> [!CAUTION])을 사용하여 강조해줘.”