콘텐츠로 이동

MkDocs 안내

이 페이지는 MkDocs 사용법과 프로젝트 구조에 대해 안내합니다.

주요 명령어

  • mkdocs new [dir-name] - 새 프로젝트 생성
  • mkdocs serve - 라이브 리로딩 문서 서버 실행
  • mkdocs build - 문서 사이트 빌드
  • mkdocs -h - 도움말 메시지 출력

프로젝트 구조

mkdocs.yml    # 설정 파일
docs/
    index.md  # 문서 홈페이지
    ...       # 기타 마크다운 페이지, 이미지 등

자세한 내용은 mkdocs.org에서 확인할 수 있습니다.