콘텐츠로 이동

Materials for MkDocs Template

손쉽게 사용자 메뉴얼 등을 작성할 수 있는 MkDocs 템플릿입니다.

미리보기

https://mkdocs.wonsama.dev

Github Template

github : pub-mkdocs-template 를 통해 빠르게 MkDocs 프로젝트를 생성할 수 있습니다.

빠른 실행

위 템플릿으로 프로젝트 생성 후, 아래 명령어를 실행합니다.

가상환경 구성

# in linux or mac
python -m venv venv
source venv/bin/activate

# in windows
# powershell 을 사용하는 것을 권장
python -m venv venv
.venv\Scripts\activate

pacakge 설치 및 실행

pip install -r requirements.txt
mkdocs serve

실행

http://localhost:9999 에 접속하여 내용을 확인하실 수 있습니다.

더 보기

좀더 자세한 내용은 위 template 을 실행 후, "시작하기" 메뉴를 참조하시기 바랍니다.

참조링크