EN 공식 웹사이트: https://www.mkdocs.org/
사용자 가이드: https://www.mkdocs.org/user-guide
시스템 요구 사항
MkDocs는 다양한 운영 체제에 설치할 수 있지만 시스템에서 Python과 pip(Python의 패키지 관리자)를 지원해야 합니다.
- 파이썬: MkDocs requires Python (>=3.7)
- 씨: MkDocs는 대부분의 Python 설치와 함께 번들로 제공되는 pip를 사용하여 설치됩니다.
다음을 실행하여 요구 사항을 확인할 수 있습니다.
파이썬 --버전pip --버전Python 또는 pip가 설치되어 있지 않은 경우 아래 단계에 따라 설치하세요.
Python과 pip 설치
파이썬 다운로드
공식 Python 다운로드 페이지로 이동하세요: https://www.python.org/downloads/
최신 버전의 Python을 다운로드하세요(버전이 3.7 이상인지 확인하세요).
설치 프로그램 실행
- 다운로드한 설치 프로그램을 두 번 클릭합니다.
- 설치화면에서 반드시 체크박스를 체크해주세요. “PATH에 Python 추가”.
- 딸깍 하는 소리 "지금 설치" 그리고 지시를 따르세요.
설치가 완료되면 이전 단계로 돌아가서 설치를 확인하세요.
SVN 저장소
시스템 요구 사항을 충족하면 다음 SVN 저장소를 확인하세요.
https://svn.woojin.info/svn/Manual/60_MkDocs
프로젝트 설치 및 실행
설치 요구 사항
더블클릭하세요 설치_요구사항.bat 모든 필수 종속성을 설치하기 위한 파일입니다.
성공적으로 실행한 후, 이름이 지정된 폴더 나의 프로젝트 환경 프로젝트 디렉토리 내부에 생성되어야 합니다.
프로젝트 실행
더블클릭하세요 서브.배트 MkDocs 서버를 시작하는 파일입니다.
터미널 창이 열리며 다음과 비슷하게 보입니다.
이제 문서는 포트 8000에서 로컬로 실행되어야 합니다. http://127.0.0.1:8000/.
프로젝트 작업을 하는 동안에는 이 터미널 창을 열어두세요!!
문서 수정
내부 문서 폴더에서 사용 가능한 모든 언어에 대한 폴더를 찾을 수 있습니다:
내에서 문서 폴더에는 사용 가능한 각 언어에 대한 하위 폴더가 있습니다.
각 폴더에는 마크다운(.md개별 페이지의 내용을 나타내는 ) 파일입니다.
이러한 파일을 수정하면 설명서의 해당 내용이 업데이트됩니다.
마크다운 파일을 편집할 때의 기본 구문과 모범 사례는 이 가이드를 참조하세요. https://www.markdownguide.org/basic-syntax