문서 템플릿 가이드
이 저장소 Markdown 노트의 공통 형식과 템플릿 위치
목차
공통 형식
모든 노트는 다음 순서를 따릅니다.
- YAML frontmatter (
title,type,module,day?,tags,status,updated) - H1 (frontmatter
title과 동일, 문서당 1개) - 한 줄 요약 (
> …) ## 목차(해당 시)- 본문 섹션
## 관련 문서
- 개행: LF only
- 파일 끝: 개행 1개
type
| type | 용도 |
|---|---|
index | 모듈/폴더 목차 |
day | dayN 학습 로그 |
concept | 개념 노트 |
architecture | 아키텍처 |
guide | 설치·운영 가이드 |
issue | 장애/이슈 기록 |
템플릿
| 파일 | 용도 |
|---|---|
| templates/day.md | Day 학습 노트 |
| templates/index.md | 모듈 인덱스 |
| templates/concept.md | 개념 노트 |
| templates/architecture.md | 아키텍처 |
| templates/guide.md | 가이드 |
정규화 스크립트
# dry-run
python3 scripts/normalize_markdown.py
# 적용
python3 scripts/normalize_markdown.py --apply
# 특정 경로만
python3 scripts/normalize_markdown.py --apply --only database