Tools / github-blog
Jekyll Basic
작년에 처음 jekyll 블로그를 만들어 보았는데요.. css고 자바스크립트고 아무것도 모르겠으니 그냥 귀엽게 만든 분의 레포지토리를 클론해서 사용했습니다. 그래서 그냥 이것저것 gpt에게 던져주면서 누덕누덕 기워서 만들었는데, 이렇게 만들다보니 제대로 이해하지 못해서 구현하고 싶은 부분은 만들지 못하고 넘어갔습니다. 이번에는 차근차근 공부하면서 나만의 블로그를 제대로 구축해보려고 합니다!!
이번 포스트에서는 jekyll이 무엇인지, Github Pages와 어떤 관계인지, 그리고 기본적인 프로젝트 구조는 어떻게 구성되어있는지 알아보겠습니다.
소개
jekyll이란 무엇인가?
jekyll은 정적 사이트 생성기입니다. 마크다운 파일과 HTML 파일을 사용해서 정적 웹사이트를 생성해줍니다.
_config.yml와 같은 설정 파일과 마크다운 파일을 읽어서 완성된 HTML 사이트를 생성합니다.
Github Pages와 무슨 관계인가?
GitHub Pages는 GitHub에서 제공하는 무료 웹 호스팅 서비스입니다. Jekyll을 공식적으로 지원하기 때문에 마크다운 파일을 푸시하기만 하면 자동으로 빌드되어 웹사이트로 배포됩니다.
GitHub Pages + Jekyll의 워크플로
- 로컬에서 마크다운 작성 → 블로그 포스트 작성
- GitHub 레포지토리에 푸시 →
git push origin main - GitHub에서 자동 빌드 → Jekyll이 HTML로 변환
- 웹사이트 자동 배포 →
username.github.io에서 확인 가능
이 과정이 모두 자동화되어 있어서 글 작성에만 집중할 수 있다는 것이 가장 큰 장점입니다.
프로젝트 구조 이해하기
Jekyll 프로젝트의 기본 구조를 살펴보겠습니다:
my-blog/
├── _config.yml # 사이트 전체 설정
├── _posts/ # 블로그 포스트들
│ └── 2025-01-01-first-post.md
├── _layouts/ # HTML 템플릿들
│ ├── default.html
│ └── post.html
├── _includes/ # 재사용 가능한 HTML 조각들
│ ├── header.html
│ └── footer.html
├── _sass/ # SCSS 부분 파일들
│ ├── _base.scss
│ └── _layout.scss
├── assets/ # CSS, JS, 이미지 등
│ └── css/
│ └── style.scss
├── index.md # 홈페이지
└── about.md # 소개 페이지
주요 폴더와 파일 역할
_config.yml: 사이트의 모든 설정을 관리하는 핵심 파일입니다. 사이트 제목, 설명, 플러그인, 테마 등을 여기서 설정합니다.
_posts/: 블로그 포스트들이 저장되는 폴더입니다. 파일명은 반드시 YYYY-MM-DD-title.md 형식을 따라야 합니다.
_layouts/: HTML 템플릿들이 저장되는 폴더입니다. 마크다운 파일들은 이 템플릿을 기반으로 완성된 HTML 페이지가 됩니다.
_includes/: 여러 페이지에서 재사용할 수 있는 HTML 조각들을 저장합니다. 헤더, 푸터, 네비게이션 등을 모듈화할 수 있습니다.
_config.yml 필수 설정들
Jekyll 사이트의 핵심인 _config.yml 파일의 기본 설정을 알아보겠습니다:
# 사이트 기본 정보
title: 개발자 블로그
email: your-email@example.com
description: >-
Jekyll과 GitHub Pages로 만든 개발 블로그입니다.
프로그래밍과 기술에 대한 이야기를 나눕니다.
# 빌드 설정
baseurl: "" # 서브 디렉토리가 있다면 "/blog" 형식으로
url: "https://username.github.io"
# 마크다운 처리
markdown: kramdown
highlighter: rouge
# 플러그인
plugins:
- jekyll-feed
- jekyll-sitemap
- jekyll-seo-tag
# 제외할 파일들
exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor
이 설정들은 Jekyll이 사이트를 빌드할 때 어떻게 처리할지를 결정합니다. 특히 baseurl과 url은 링크 생성에 중요하므로 정확히 설정해야 합니다.
참고 자료: