Git 5

복습¶

user.github.io¶

user.github.io 란?¶

user.github.io 은 Github 이 제공하는 개인 블로그 플랫폼입니다. 이 블로그는 Github repositoy에 있는 index.html 파일과 각각의 *.html 파일들이 랜더링 된 것입니다.

이처럼 Github 에 아이디만 있다면 자신의 아이디로 user.github.io 라는 이름을 가진 레포지토리를 생성하고 그곳에 index.html 과 메모하거나 게시하고 싶은 정보를 .html 파일로 만들어 레포지토리를 commit 하고 Github 에 push 하면 자동으로 user.github.io 에 게시가 시작됩니다.

Github 페이지 공식 메뉴얼 : https://pages.github.com/

오늘 저희는 MkDocs를 이용해서 개인 github.io 블로그를 만들어보도록 하겠습니다.

MkDocs¶

MKDocs 는 글쓰기 도구입니다. 글쓰기 도구에는 sphinx, read docs 등 다양한 도구들이 있습니다. MKDocs 는 간편하고, 마크다운 방식으로 글쓰기를 하며, serve 라는 명령어를 통해서 실시간으로 글쓰는 모습을 확인할수 있어서 선택하였습니다.

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

Python 설치¶

MKDocs 는 Python이 설치되어 있어야하며 Python 패키지 관리자인 pip가 있어야합니다 설치가 안되어있다면 설치한 후 진행을 해야합니다.

가장 시간이 오래 걸릴거 같은 부분...

Win OS
시스템 환경 변수 편집 > 환경변수 > Path 펀집

''' C:\Users\customer\AppData\Local\Programs\Python\Python37-32\ '''

위와 비슷하게 경로 추가 후 가장 위로 올려준다.

Mac OS python을 새로 설치한다.

Python 설치가 완료 되었다면

python --version
pip --version

위의 코드로 파이썬이 제대로 설치 되었는지 확인해본다.

mkdocs 설치¶

명령창에 아래코드를 입력하여 mkdocs 를 설치합니다.

pip install mkdocs

작업폴더 생성¶

new 키워드를 이용해서 작업할 디렉토리를 생성합니다.

cd Desktop
mkdocs new mkdocs-tuts

그럼 바탕화면에 mkdocs-tuts 라는 폴더가 생기고 폴더 안에는 mkdocs.yml 과 docs/index.md 가 생성이 됩니다.

실시간 확인하기¶

먼저 작업 디렉토리로 이동합니다.

cd mkdocs-tuts

serve 키워드를 이용해서 실시간 작업을 확인합니다.

mkdocs serve

그럼 http://127.0.0.1:8000 혹은 localhost : 8000 에서 확인 가능합니다.

바뀌는 내용은 실시간으로 확인이 가능합니다.

정지할때는 ctrl + c를 누르면 정지하빈다.

빌드하기¶

배포하기전에 빌드를 해서 종속된 팡일들을 모두 생성합니다.

mkdocs build

구조를 보면 site라는 폴더가 생성이 되고 종속된 파일들이 설치가 된걸 볼 수 있습니다.

배포¶

mkdocs로 제작된 문서들은 [github.com]저장소에 올리면 ~.io라는 도메인으로 호스팅 됩니다.

먼저 배포를 하기전 마지막으로 mkdocs build 를 해서 최종파일을 만들어놉니다.

배포를 하려면 아래의 명령어를 사용하면 됩니다.

mkdocs gh-deploy

과제¶

자신의 github.io 블로그에 지난번에 만든 readme.md 파일을 올리기
구글드라이브에 개인 블로그 url 올리기

참고 사이트 : https://demun.github.io/mkdocs-tuts/