빗자루넷 따라하기

셋업 Setup

Windows

가상 환경 Virtual Environment

python-2.7 + virtualenv

C:\> virtualenv \Python27\venvs\mkdocs
C:\> \Python27\venvs\mkdocs\Scripts\active
(mkdocs) C:\> pip install mkdocs
(mkdocs) C:\> pip install pygments
(mkdocs) C:\> pip install pymdown-extensions
(mkdocs) C:\> pip install mkdocs-material

새로운 사이트 New Site

(mkdocs) C:\> md \GitHub
(mkdocs) C:\> cd \GitHub
(mkdocs) C:\GitHub> md \myevan
(mkdocs) C:\GitHub> cd \myevan
(mkdocs) C:\GitHub\myevan> mkdocs new .

사이트 미리 보기 Preview Site

로컬 서버를 통해 실제 출력되는 모습을 확인할 수 있습니다.

(mkdocs) C:\GitHub\myevan> mkdocs serve

http://localhost:8000 접속하면 미리 보기가 가능합니다. 변경 사항도 바로 적용됩니다.

POSIX

  • macOS Sierra 10.12.1
  • Windows 10 Professional + Windows Subsystem for Linux

가상 환경 Virtual Environment

python-2.7 + virtualenvwrapper

$ mkvirtualenv mkdocs
(mkdocs)$ pip install mkdocs
(mkdocs)$ pip install pygments
(mkdocs)$ pip install pymdown-extensions
(mkdocs)$ pip install mkdocs-material

새로운 사이트 New Site

(mkdocs)$ mkdir GitHub
(mkdocs)$ cd GitHub
(mkdocs)$ mkdir myevan
(mkdocs)$ cd myevan
(mkdocs)$ mkdocs new .

사이트 미리 보기 Preview Site

로컬 서버를 통해 실제 출력되는 모습을 확인할 수 있습니다.

(mkdocs)$ mkdocs serve

http://localhost:8000 접속하면 미리 보기가 가능합니다. 변경 사항도 바로 적용됩니다.

설정 Configuration

예제 Example

mkdocs.yml

:::yaml
site_name: "myevan.net"
theme: material
markdown_extensions:
    - codehilite
pages:
    - "home": index.md
    - "tutorials": 
        - "myevan site": mkdocs_tutorial.md

속성 Properties

  • site_name: 사이트 이름
  • theme: 테마
  • markdown_extensions: 마크 다운 확장
    • codehilite: 문법 강조 지원
  • pages: 페이지 이름과 마크다운 파일 맵핑, 계층 구조 지원

배포 Deployment

Windows

페이지 저장소를 site 디렉토리에 클론 받습니다.

(mkdocs) C:\GitHub\myevan> git clone https://github.com/myevan/myevan.github.io site

홈 저장소에서 site 디렉토리를 버전 관리하지 않도록 무시 설정해 줍니다.

(mkdocs) C:\GitHub\myevan> vim .gitignore
/site

빌드하면 site 디렉토리에 정적 사이트가 만들어집니다.

(mkdocs) C:\GitHub\myevan> mkdocs build

git 을 사용해서 정적 사이트 배포가 가능합니다.

(mkdocs)$ C:\GitHub\myevan> (cd site;git commit -a)
(mkdocs)$ C:\GitHub\myevan> (cd site;git push)

배포된 사이트는 https://myevan.github.io 에서 확인 가능합니다.

POSIX

페이지 저장소를 site 디렉토리에 클론 받습니다.

(mkdocs)$ git clone https://github.com/myevan/myevan.github.io site

홈 저장소에서 site 디렉토리를 버전 관리하지 않도록 무시 설정해 줍니다.

(mkdocs)$ vim .gitignore
/site

빌드하면 site 디렉토리에 정적 사이트가 만들어집니다.

(mkdocs)$ mkdocs build

git 을 사용해서 정적 사이트 배포가 가능합니다.

(mkdocs)$ (cd site;git commit -a)
(mkdocs)$ (cd site;git push)

배포된 사이트는 https://myevan.github.io 에서 확인 가능합니다.

커스텀 도메인 Custom Domain

https://help.github.com/articles/about-supported-custom-domains/#apex-domains