Documentation

특수 기능 활용

마크다운의 기본 문법 외에도 독자의 이해를 돕고 가독성을 극대화하기 위한 특수 기능들을 제공합니다.

중요도나 성격에 따라 5가지의 알림(Callout) 구문을 적절히 사용하여 문서의 핵심 내용을 시각적으로 강조하세요.

[!NOTE] 독자에게 참고가 될 만한 일반적인 배경 정보나 부연 설명입니다.

[!TIP] 더 효율적으로 작업할 수 있는 팁이나 권장하는 모범 사례입니다.

[!IMPORTANT] 기능을 이해하거나 사용하는 데 있어 반드시 알아야 하는 핵심 내용입니다.

[!WARNING] 주의가 필요한 사항으로, 무시할 경우 오류나 원치 않는 결과가 발생할 수 있습니다.

[!CAUTION] 데이터 손실, 보안 위험 등 치명적인 결과로 이어질 수 있는 강력한 경고입니다.

어려운 용어나 긴 부가 설명이 본문의 흐름을 방해하지 않도록 각주 기능을 지원합니다.

문장 뒤에 이와 같이 각주 기호를 표시합니다.1

1

각주에 대한 상세 설명은 본문 제일 하단에 자동으로 모여 깔끔하게 렌더링됩니다.

모든 소스 코드는 반드시 언어 식별자가 포함된 펜스(Fence) 코드 블록으로 작성해야 합니다. Git Static Doc Server는 VS Code의 핵심 엔진인 Monaco Editor를 통해 이를 렌더링하므로, 높은 가독성의 신택스 하이라이팅과 코드 복사 기능을 제공합니다.

// 예시 코드
function welcome() {
    console.log("Welcome to Git Static Doc Server!");
}

흐름도(Flowchart), 시퀀스 다이어그램 등 텍스트만으로 설명하기 복잡한 구조나 절차를 시각화할 때 사용합니다. 다만, 텍스트나 목록으로 충분히 설명 가능한 내용에는 남용하지 마십시오.

graph TD; A[문서 작성] --> B(Git Push); B --> C{자동 배포}; C -->|성공| D[웹 서비스 반영]; C -->|실패| E[오류 알림];

본문의 헤더(#)를 분석하여 문서 화면 우측 또는 상단에 내비게이션 트리를 자동 생성합니다. 이를 통해 독자는 긴 문서에서도 원하는 섹션으로 빠르게 이동할 수 있습니다.