이 글은 블로그를 만들다가 계속 실패하면서 열받아가지고 정리한 글이다.
참고하는 정도로만 봐주면 될것 같다.
환경설정
- Window
- Ruby 3.1
- Jekyll
- Chirpy Theme 5.4.0
시작하기 전에 Ruby랑 Jekyll은 미리 설치하고 간다.
Ruby는 웹사이트를 쉽고 빠르게 만들기 위해 사용
Jekyll은 Ruby 기반의 정적 웹사이트 생성기
- Ruby 설치
1
https://www.ruby-lang.org/ko/downloads/
- Jekyll 설치
1
$ gem install jekyll bundler
※ 참고로 Chirpy Theme는 Window 기반에서는 최악이라는 말이 있더라.. (생각하니까 열받네)
블로그 생성
1. Repository Create
1
Repository name은 {username}.github.io 형식으로 만들어준다.
2. Repository Clone
- Chirpy Theme Down
1
2
3
4
5
6
7
8
9
10
11
12
13
14
■ https://github.com/cotes2020/jekyll-theme-chirpy/
1. Git Fork
- 별도 설명 안함
2. Chirpy Stater (Quick Starter)
- 최소 설정
- 초기화 기본 완료
- 커스터마이징이 제한적이다
3. Zip Download
- 전체 설정
- 초기화 수동 필요
- 커스터마이징이 자유롭다
※ 위 3가지의 방법 중에 나는 3. Zip Download로 진행했다.
- Repository Clone
1
2
3
4
5
6
7
8
9
10
11
1. URL Copy
2. Git Clone
3. Clone 경로에 다운받은 Chirpy 소스 복사
※ 3. Zip Download 방식으로 설명
$ mkdir git (원하는 경로에 가서 폴더 하나 만들고.. 폴더명은 맘대로)
$ git clone {URL}
$ git status
$ git add * .*
$ git commit -m "Chirpy Theme Init"
$ git push
3. Chirpy Init
- GitHub Pages Setting
1
2
3
4
5
6
7
8
1. Settings [Click]
2. Pages [Click]
3. Branch 설정
※ Build 와 Deploy를 위한 Branch를 설정하는 작업이다.
※ Chirpy는 Commit & Push를 하면 자동으로 gh-pages 브랜치가 생성된다 하는데
[나는 별짓을 해도 안되서 열만 받고 그냥 main으로 설정]하고 진행했다.
gh-pages 브랜치를 생성해서 하고 싶은 사람은 직접 찾아보고 제발 나한테도 알려줬으면 좋겠다.
- Chirpy Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
* Chirpy Theme 초기화
$ bash tools/init
fatal: No names found, cannot describe anything.
※ 한번에 될 수도 있지만, 다음과 같은 에러가 날 수도 있다..
Tag 하나 만들어주자.. 이유는 직접 찾아보길.. (열받네)
$ git tag v1.0.0 (Tag 생성)
$ git push origin v1.0.0 (Tag Push)
$ bash tools/init
※ 아래 메세지가 출력되면 성공이다.
[INFO] Initialization successful!
$ git push
※ 초기화가 되고 나면 Commit이 1개 추가되는데 바로 push 해준다.
※ [Commit Message] chore: Initialize the environment
※ Build And Deploy가 성공으로 처리되어야 한다.
- Test Site
1. 로컬 확인
1
2
3
4
5
6
7
$ bundle (or bundle install) : 빌드
$ bundle exec jekyll serve : 서버 시작
Server address: http://127.0.0.1:4000/ : 로컬 URL
Server running... press ctrl-c to stop. : 서버 종료
※ 서버 시작 시, _site 폴더가 생성되어야 함
2. 운영 확인
1
2
3
4
5
6
7
1. GitHub 메뉴에서 확인
- Settings [Click]
- Pages [Click]
- Site URL [Click]
2. 브라우저 주소창 입력
- https://{username}.github.io/
※ 최초 사이트 이미지
1
https://{username}.github.io/ 의 주소로 출력되는 것을 확인할 수 있다.
4. Configuration
여기부터가 진정한 열받음의 시작이었다.
정리해보니 별거 없어보이지만 진짜 고생덩어리..
- pages-deploy.yml (.github\workflows)
Build & Deploy 대상 branch, 권한, Ruby 등을 설정하는 파일이다.
1. Build & Deploy 대상 branch 설정
1
2
3
4
5
6
7
8
9
name: "Build and Deploy"
on:
push:
branches:
- main
- master (삭제)
# 맨 위에 branch가 아마 main하고, master로 설정되어 있을텐데
나는 master를 삭제하고 main만 남겼다. (gh-pages가 생성됐으면 그걸로.. 부럽다.)
2. Ruby 설정
1
2
3
4
5
6
7
8
9
10
$ ruby -v (본인 Ruby Version 확인)
ruby 3.1.3p185 ...
name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1' (여기)
Ruby Version 이 맞지 않으면 Build 에러가 발생할 수 있다.
본인이 설치한 Ruby Version을 확인 후 동일하게 맞춰준다.
- config.yml
GitHub 연동정보, 언어, 이미지, 소셜 정보 등 기본 구성들을 설정하는 파일이다.
난 기본적으로 4가지만 적용했다. 나머지 설정은 다른 곳에서 찾아보길..
5. GitHub Pages Apply
1
2
3
4
5
6
7
■ Build 파일 제외
.gitignore에 Gemfile.lock 추가
# Gemfile.lock
로컬에서 빌드 시에 생성되는 파일
GitHub 배포 시, 빌드 오류를 발생시킬 수 있기 때문에 제외
- Config Init
1
2
3
4
5
6
7
$ git status
modified: .github/workflows/pages-deploy.yml
modified: .gitignore
modified: _config.yml
$ git add * .*
$ git commit -m "Config Init"
$ git push
마무리
원래는 에러가 엄청 많이 나서 열받아서 작성하고 있었는데..
에러를 하나하나 해결하다 보니 깔끔하게 끝났다..
그래도 잘 끝나서 다행이다. (화가 내려간다..)