본문 바로가기
일반
2021.02.22 18:09

MKDocs (2) - Docker로 Build하기

다물칸 주소복사
조회 수 9 추천 수 0 댓글 0
?

단축키

Prev이전 문서

Next다음 문서

크게 작게 위로 아래로 댓글로 가기 인쇄
?

단축키

Prev이전 문서

Next다음 문서

크게 작게 위로 아래로 댓글로 가기 인쇄
Extra Form
구분 팁&트릭
출처 내가작성

목차

MKDocs (1) - 소개 및 설정방법

MKDocs (2) - Docker로 Build하기

MKDocs (3) - Docker로 실행하기

 

파이썬 설치가 윈도우나 리눅스나 거지같다. 

MKDocs 설치방법이나 사용법은 인터넷에 많은 관계로 Docker로 실행하는 스크립트만 올려본다. 

MKDocs란? 도움말, 개발문서 등을 정적으로 관리하기 위한 툴이라고 보면 되며, 이와 비슷한 것으로 readtodocs, sphinx 등이 있다. 

오전에는 스핑크스에 매달렸는데 찾다가 MKDocs은 기본적으로 마크다운을 지원하고 기타 부가기능도 지원을 해서 

오후에는 여기에 매진... 개발은 안하고 딴짓하고 있다. 

 

Docker 하이라이트 기능은 제공하지 않은 관계로... 

 

리눅스는 우분투를 기반으로 하였다. 

mkdocs 설치 시 파이썬 최소 3.6이라서 업그레이드 작업등을 거쳤다.

 

mkdocs 설치 및 테마와 플러그인 설치

dockerfiles/src는 실제 mkdocs의 소스폴더이다. 깃헙이나 깃랩에서 다운받아 자동으로 빌드스크립트를 구현하면 된다.

 

UTF-8 환경을 넣지 않으면 오류가 발생해서 넣어줬다.

 

mkdocs server 옵션을 넣지 않으면 기본적으로 127.0.0.1로 서버가 기동된다. 이럴경우 도커 컨테이너 밖에서 연결이 안되기 때문에

0.0.0.0:8000 을 지정하였다. 0.0.0.0으로 리스닝 포트로 서버를 기동하면 포트를 통해 외부접근이 가능해진다.

 

FROM ubuntu:16.04

RUN apt-get update
RUN apt-get upgrade
RUN apt-get install -y software-properties-common

# Python 3.6 Install
RUN add-apt-repository ppa:deadsnakes/ppa
RUN apt-get update
RUN apt-get install -y curl python3.6
RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.5 1
RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.6 2
RUN update-alternatives --config python3
RUN python3 --version

# Python-pip Install
RUN curl https://bootstrap.pypa.io/get-pip.py | python3

RUN pip --version
RUN pip install --upgrade pip
RUN pip install mkdocs
RUN pip install mkdocs-rtd-dropdown
RUN pip install mkdocs-material
RUN pip install pymdown-extensions

ENV LC_ALL=C.UTF-8
ENV LANG=C.UTF-8

WORKDIR /app

COPY dockerfiles/src /app

EXPOSE 8000

CMD mkdocs serve -a 0.0.0.0:8000

 

MKdocs를 Material로 돌린 다른 사이트

  https://mkdocs.peaceiris.com/