설치

1. Python 설치

MkDocs는 Python으로 작성되어 있으므로, 먼저 Python 설치

  1. Python 공식 사이트에서 최신 버전 다운로드
  2. 설치 프로그램을 실행하고, “Add Python to PATH” 옵션을 체크한 후 “Install Now"클릭

2. MkDocs 설치

Python이 설치된 후, MkDocs를 설치

  1. 명령 프롬프트(CMD) 실행
  2. 다음 명령어를 입력하여
    • pip 업데이트
    • MkDocs 설치
python -m pip install --upgrade pip
pip install mkdocs

mkdocs_install

3. MkDocs 프로젝트 생성

  1. 명령 프롬프트에서 작업하고자 하는 디렉터리로 이동
> cd path\to\your\directory
  1. 새로운 MkDocs 프로젝트 생성
> mkdocs new my-project
  1. 생성된 프로젝트 디렉터리로 이동
> cd my-project

4. MkDocs 서버 시작

MkDocs에는 내장된 개발 서버가 있어 로컬 환경에서 문서 확인 가능

  1. 아래 명령어를 입력하여 개발 서버를 시작합니다.
> mkdocs serve
  1. 브라우저에서 http://127.0.0.1:8000 로 이동하여 MkDocs 확인

mkdocs_serve

mkdocs_local