본문으로 건너뛰기
가이드
이 페이지의 내용
  1. 방식 고르기
  2. GitHub Pages
  3. Jekyll 4
  4. github-pages gem
  5. 최소 설정
  6. 빌드 확인
  7. 다음
페이지 도구

설치

이미 쓰는 빌드 방식을 고르세요. 세 방식 모두 같은 Markdown을 읽습니다.

참고

이 페이지는 영어 원문의 번역입니다. 내용이 다르면 영어 문서가 우선합니다.

방식 고르기

GitHub Pages

# _config.yml (기본 GitHub Pages 빌드, Gemfile 불필요)
remote_theme: modootoday/jekyll-theme-modootoday@v1.4.1
plugins: [jekyll-remote-theme]

Jekyll 4

# Gemfile
source "https://rubygems.org"
gem "jekyll", "~> 4.4"
gem "jekyll-theme-modootoday", "~> 1.4"

github-pages gem

# Gemfile (GitHub Pages 환경을 로컬에서 재현)
source "https://rubygems.org"
gem "github-pages", "~> 232", group: :jekyll_plugins

최소 설정

pretty 퍼머링크를 쓰고 모든 페이지에 doc 레이아웃을 지정합니다.

theme: jekyll-theme-modootoday
lang: ko
permalink: pretty
markdown: kramdown
kramdown: {input: GFM}
defaults:
  - {scope: {path: ""}, values: {layout: doc}}

팁

remote_theme을 쓸 때는 theme: 줄 대신 GitHub Pages 탭의 remote_theme 두 줄을 넣으세요.

빌드 확인

bundle exec jekyll build
bundle exec modootoday-check . _site --twins

검사기는 github.com에서 똑같이 보이지 않을 문법을 알려 줍니다.

remote_theme 사이트는 Gemfile에 테마가 없으므로 bundle exec modootoday-check를 쓸 수 없습니다. 테마 태그와 같은 마이너 버전으로 gem을 한 번 설치하고, 빌드한 사이트에 검사기를 실행합니다.

gem install jekyll-theme-modootoday -v '~> 1.4'
modootoday-check . _site --twins

셸이 modootoday-check를 찾지 못하면 gem의 bin 디렉터리가 PATH에 없는 것입니다. ruby -S modootoday-check . _site --twins로 실행합니다. can't find gem jekyll-theme-modootoday (Gem::GemNotFoundException)으로 멈추면 PATH에 있는 스크립트가 다른 gem 위치(다른 Ruby, 또는 버전 관리자가 설정한 GEM_HOME/GEM_PATH)의 것입니다. gem install이 쓴 위치를 Ruby에 알려 줍니다.

GEM_PATH="$(gem env gemdir)" ruby -S modootoday-check . _site --twins

gem을 설치하지 않으려면 릴리스 소스에서 검사기를 실행합니다. Ruby만 있으면 됩니다.

curl -sL https://github.com/modootoday/jekyll-theme-modootoday/archive/refs/tags/v1.4.1.tar.gz | tar xz -C /tmp
ruby /tmp/jekyll-theme-modootoday-1.4.1/exe/modootoday-check . _site --twins

remote_theme 줄에 적은 태그를 씁니다.

GitHub Actions에서는 빌드 다음 단계에 같은 두 줄을 넣습니다. 예: run: gem install jekyll-theme-modootoday -v '~> 1.4' && modootoday-check docs docs/_site --twins.

github-pages gem이 내는 경고 두 가지는 무시해도 됩니다. To use retry middleware with Faraday v2.0+, install faraday-retry gem이 나와도 원격 테마는 정상으로 내려받습니다. @import에 관한 Sass 안내는 GitHub Pages의 Sass가 경고 숨김 옵션을 읽지 않는 이전 버전이라서 _config.yml에 설정해도 계속 나옵니다. 어느 쪽이든 빌드 결과는 정상입니다.

다음

첫 페이지 쓰기 홈으로

이 페이지 편집