github page - jekyll, 깃허브 페이지 지킬의 사용 팁

2021-11-27 • infoqoch •

•

깃허브 페이지와 지킬

깃허브는 깃허브 페이지라는 무료 호스팅을 제공한다. SSL도 무료로 적용해준다. 도메인도 제공한다.
깃허브 페이지는 프레임워크 jekyll에 대한 CI/CD를 제공한다.
- 깃허브는 ruby로 만들어졌고, 지킬은 루비의 프레임워크 중 하나이다.
- 깃허브 페이지가 바라보는 리포지토리에 지킬의 소스코드를 push하면, 깃허브가 자동으로 소스코드를 html 파일로 렌더링 해준다.
- 웹 어플리케이션을 서버에 자동으로 띄워준다.
지킬은 static rendering pages이다.
- 스프링은 런타임 시점에서 동적으로 html을 렌더링한다.
- 지킬은 런타임 전에 html을 생성한 후 로딩한다.
깃허브 페이지는 무료 도메인도 제공한다.
- 기본적으로 제공하는 도메인은 다음과 같은 형태이다 : https://{userid}.github.io
- 현재 블로그의 주소는 다음과 같다 : https://infoqoch.github.io/
- 자신의 도메인이 있으면 그것으로 설정할 수 있다.
지킬은 마크다운을 지원한다.
- 마크다운은 간단하지만 효과적인 문서 작성 포맷이다.
- 마크다운 문서를 파일로서 관리할 수 있다. 블로그 이전 및 관리 측면에서 그 어떤 블로그보다 편리하다.
git-page의 리포지토리는 기본적으로 public이다. private으로 변환하기 위해서는 유로 구독이 필요하다. 현재 나는 매달 4불을 지급하고 private 리포지토리로 변환하였다.

미세 팁

가이드를 위한 글을 작성하기에는 루비나 지킬을 잘 모른다.
블로그 생성 과정에서 겪었던 미세한 팁을 공유코자 한다.

지킬 공식 문서

깃허브페이지는 지킬 프레임워크의 모든 기능을 지원하지 않는다. 그러므로 공식 문서에서 깃허브 페이지의 기능 제공 여부를 확인해야 한다.
공식문서 주소는 다음과 같다 : https://jekyllrb-ko.github.io/
지킬 다양한 테마를 지킬 공식 문서에서 제공한다. 주소는 다음과 같다 : https://jekyllrb-ko.github.io/docs/themes/

마크다운 앞뒤로 줄바꿈

코드 블럭 앞 뒤에 줄바꿈이 없으면 마크다운이 적용되지 않는다.
해당 내용은 내가 사용하는 테마만 그런지 아니면 지킬 전체가 그런지는 정확하게 모른다. 혹시 코드블럭이 깨질 경우 아래와 같이 줄바꿈을 넣어보자.

# 좋은 코드를 작성해보자
- 좋은 코드의 예시는 다음과 같다.
\```java
public class GoodCode{
    // 
}
\```
- 더 좋은 코드는 아래와 같다.

다음과 같이 작성해야 한다.

# 좋은 코드를 작성해보자
- 좋은 코드의 예시는 다음과 같다.

\```java
public class GoodCode{
    // 생략
}
\```

- 더 좋은 코드는 아래와 같다.

url path의 정의

post에 대한 기본적인 url path는 다음과 같다 : /categories/yyyy/MM/dd/title
permalink를 사용하면 path를 변경 가능하다.
- permalink: /any-title-you-want
- 카테고리와 (날짜를 제외한) 파일명을 동적으로 적용하고 싶으면 다음과 같이 작성한다 : permalink: /:categories/:title.html

주요 커맨드

세팅이 다 끝났다는 가정 하에 지킬과 관련하여 사용하는 커맨드를 정리하고자 한다. 보통 로컬 테스트 때 사용하는 커맨드이다.
지킬 서버 로딩 : bundle exec jekyll serve