📌 GitHub Wiki 개요

1. GitHub Wiki란?

GitHub Wiki는 프로젝트 문서를 체계적으로 관리하고 공유할 수 있는 문서화 도구입니다.
리포지토리(저장소)와 함께 제공되며, 프로젝트의 개요, 사용법, 설치 가이드 등을 정리하는 용도로 사용됩니다.

---

2. GitHub Wiki의 주요 특징

• 리포지토리 내에서 프로젝트 문서화 가능
• Markdown 기반 문서 작성 지원
• 문서를 체계적으로 정리 가능 (목차, 링크 활용)
• 협업이 용이 (여러 명이 동시에 편집 가능)
• 오픈소스 프로젝트에서 공식 문서 역할 수행

---

3. GitHub Wiki의 활용 예시

1. 프로젝트 개요 문서화
   • 프로젝트의 목적, 개요 및 기능 설명
2. 설치 및 실행 방법 안내
   • 환경 설정, 설치 방법, 실행 방법 가이드 제공
3. API 문서 제공
   • REST API 엔드포인트 설명, 데이터 형식 정리
4. 개발자 가이드 작성
   • 코드 구조 설명, 기여 방법 안내
5. 버전 관리 및 변경 로그 기록
   • 릴리즈 노트 및 업데이트 내용 정리

---

4. GitHub Wiki 사용 방법

🔹 Wiki 활성화

1. GitHub 리포지토리에서 Wiki 탭 클릭
2. "Enable Wiki" 버튼 클릭하여 활성화

🔹 문서 작성

1. "New Page" 버튼 클릭
2. Markdown 문법을 사용하여 문서 작성
3. "Save Page" 클릭하여 저장

🔹 Wiki 페이지 연결

• [페이지 제목](링크) 형식으로 내부 문서 링크 가능
• 예시: [프로젝트 개요](Home)

---

5. GitHub Wiki와 README의 차이점

구분	GitHub Wiki	README 파일
문서 위치	별도 Wiki 탭에서 관리	리포지토리의 루트 디렉토리
문서 구조	여러 페이지로 구성 가능	단일 파일로 구성
사용 목적	상세한 문서 및 가이드 제공	프로젝트 요약 및 소개
편집 방식	GitHub UI에서 직접 편집 가능	Markdown 파일로 작성 및 커밋

---

6. 정리

🔹 GitHub Wiki는 프로젝트 문서를 체계적으로 관리하는 도구
🔹 Markdown을 사용하여 쉽게 문서를 작성하고 공유 가능
🔹 README보다 상세한 가이드와 협업 문서 작성에 적합

GitHub Wiki를 활용하면 오픈소스 프로젝트, 협업 개발, 내부 문서화 등에 유용하게 사용할 수 있습니다! 🚀