시작하기 및 기본 규격

Git Static Doc Server는 Git 저장소에 저장된 마크다운(.md) 파일을 파싱하여 웹 문서 서비스로 자동 변환 및 제공하는 플랫폼입니다. 모든 문서는 작성 후 Git push 만으로 서비스에 즉시 반영됩니다.

문서의 최상단에는 Frontmatter를 통해 속성을 정의할 수 있습니다. 단, title, date, description은 시스템이 본문 내에서 자동 추출하므로 생략 가능하며, 특별한 제어가 필요한 경우(예: 태그 지정, 접근 제한 등)에만 제한적으로 사용합니다.

---
tags: [문서작성, 기초]
password: "1234"    # 해당 비밀번호를 알아야만 문서 열람 가능
private: true       # 설정 시 전체 목록 및 검색에서 완전 숨김 처리
book_only: true     # Book 시스템 내부에서만 읽을 수 있도록 단독 노출 제외
---

[!NOTE] 자동 추출 기준

• 제목: 문서 본문의 첫 번째 헤더(# 제목)
• 날짜: Git 저장소 커밋 이력 상의 최초 작성일
• 요약: 문서 시작 부분의 텍스트 일부 자동 발췌

문서가 위치한 폴더 안에 blogcat.yaml 파일을 생성하여 화면 좌측 메뉴(카테고리)에 표시될 이름과 정렬 순서를 지정할 수 있습니다.

name: "문서 작성 가이드"
seq: 10

[!TIP] seq 값이 낮을수록 상단에 메뉴가 배치됩니다. 하나의 카테고리 폴더 하위에서 문서를 체계적으로 정리하고 싶을 때 유용합니다.