MkDocs에 대해서

MkDocs란?

MkDocs는 Markdown 파일을 기반으로 정적 웹사이트 형태의 문서를 생성하는 정적 사이트 생성기(Static Site Generator)입니다.

• 주 사용 목적 - 프로젝트 문서화 (예: API 문서, 사용자 매뉴얼, 개발자 문서 등)
• 언어 기반 - Python
• 문서 작성 방식 - Markdown(.md) 파일로 작성
• 출력 결과물 - HTML 파일 (정적 웹사이트)

주요 특징

• 설정이 간단한 mkdocs.yml 설정 파일 사용
• mkdocs serve 명령으로 로컬에서 실시간 미리보기 지원
• GitHub Pages 배포에 최적화되어 있음
• 다양한 테마 및 플러그인 지원

Material for MkDocs란?

Material for MkDocs는 MkDocs의 가장 인기 있고 강력한 테마입니다.

• Google의 Material Design 원칙을 따름
• MkDocs에 미려한 UI/UX 제공
• 풍부한 기능(검색, 버전 관리, 탭, 다국어, 코드 복사 버튼 등)

주요 기능

• 모바일 최적화: 반응형 디자인 제공
• 코드 하이라이팅: Pygments 기반 코드 색상 지원
• 풀텍스트 검색: JavaScript 기반 내장 검색 기능
• 버전 관리: 다중 버전 문서 관리 플러그인 연동 가능
• 확장성: 다양한 MkDocs 플러그인과 호환
• 자동 TOC (목차) 생성