Jekyll을 사용하여 로컬로 GitHub Pages 사이트 테스트

리포지토리에 대한 읽기 권한이 있는 사용자는 로컬에서 GitHub Pages 사이트를 테스트할 수 있습니다.

필수 조건

Jekyll을 사용하여 사이트를 테스트하려면 먼저 다음을 수행해야 합니다.

• Jekyll 설치
• Jekyll 사이트를 만듭니다. 자세한 내용은 "Jekyll을 사용하여 GitHub Pages 사이트 만들기"을(를) 참조하세요.

Bundler를 사용하여 Jekyll을 설치하고 실행하는 것이 좋습니다. Bundler는 Ruby gem 종속성을 관리하고 Jekyll 빌드 오류를 줄이며 환경 관련 버그를 방지합니다. Bundler를 설치하려면 다음을 수행합니다.

1. Ruby를 설치합니다. 자세한 내용은 Ruby 설명서에서 “Ruby 설치”를 참조하세요.
2. Bundler를 설치합니다. 자세한 내용은 “Bundler”를 참조하세요.

로컬로 사이트 빌드

1. Terminal(터미널)Terminal(터미널)Git Bash를 엽니다.

2. 사이트의 게시 원본으로 이동합니다. 자세한 내용은 "GitHub Pages 사이트에 대한 게시 원본 구성"을(를) 참조하세요.

3. bundle install를 실행합니다.

4. Jekyll 사이트를 로컬로 실행합니다.

   $ bundle exec jekyll serve
   > Configuration file: /Users/octocat/my-site/_config.yml
   >            Source: /Users/octocat/my-site
   >       Destination: /Users/octocat/my-site/_site
   > Incremental build: disabled. Enable with --incremental
   >      Generating...
   >                    done in 0.309 seconds.
   > Auto-regeneration: enabled for '/Users/octocat/my-site'
   > Configuration file: /Users/octocat/my-site/_config.yml
   >    Server address: http://127.0.0.1:4000/
   >  Server running... press ctrl-c to stop.
   

   Note

   • Ruby 3.0 이상을 설치한 경우(Homebrew를 통해 기본 버전을 설치한 경우) 이 단계에서 오류가 발생할 수 있습니다. 이러한 버전의 Ruby에는 더 이상 webrick이 설치되어 있지 않기 때문입니다.

     오류를 해결하려면 bundle add webrick 실행을 시도한 다음 bundle exec jekyll serve를 다시 실행합니다.

   • _config.yml 파일의 baseurl 필드에 GitHub 리포지토리의 링크가 포함된 경우 로컬로 빌드할 때 다음 명령을 사용하여 해당 값을 무시하고 사이트에서 localhost:4000/ 서비스를 제공할 수 있습니다.

     bundle exec jekyll serve --baseurl=""
     

5. 사이트를 미리 보려면 웹 브라우저에서 http://localhost:4000으로 이동합니다.

GitHub Pages gem 업데이트

Jekyll은 자주 업데이트되는 활성 오픈 소스 프로젝트입니다. 컴퓨터의 github-pages gem이 GitHub Pages 서버의 github-pages gem과 함께 오래된 경우 사이트를 로컬로 구축할 때와 GitHub Enterprise Cloud에 게시할 때와 다르게 보일 수 있습니다. 이를 방지하려면 컴퓨터에서 github-pages gem을 정기적으로 업데이트하세요.

1. Terminal(터미널)Terminal(터미널)Git Bash를 엽니다.
2. github-pages gem을 업데이트합니다.
   • Bundler를 설치한 경우 bundle update github-pages를 실행합니다.
   • Bundler가 설치되어 있지 않으면 gem update github-pages를 실행합니다.

추가 참고 자료

• Jekyll 설명서의 GitHub Pages