[Docusaurus] Github page로 배포하기

Docusaurus 프로젝트를 Github page에 호스팅하는 방법을 안내합니다. 정상적인 Docusaurus 프로젝트 레포지토리가 있음을 가정합니다. 

 

Branch 구성 

아래와 같이 Github page repository의 브랜치들을 구성해 주세요. 

• main (default)
• gh-pages

gh-pages 브랜치가 없는 경우 생성해 주세요. 도큐사우루스 DeploymentBranch 기본값이 gh-pages 입니다.

위 구성과 같이 gh-pages 브랜치가 기본 브랜치가 아니어야 합니다. 

 

Github pages 설정 

깃허브 프로젝트 -> settings -> pages 에서 Branch를 gh-pages, /(root)로 설정해 주세요.

 

빌드 및 배포

[ 프로젝트 빌드 ]

yarn build

 

[ 브랜치 확인 및 변경 ]  

배포 시, gh-pages 브랜치가 아니라 다른 브랜치에서 배포 명령을 실행해야 합니다. 터미널에서 현재 브랜치를 확인하고 필요 시 바꾸어 주세요. 

git branch
* main
gh-pages

현재 브랜치가 main 임을 확인했습니다.

 

[ 배포 ] 

GIT_USER=깃허브계정아이디 yarn deploy

 

참고 자료 

Deployment | Docusaurus

Creating a GitHub Pages site - GitHub Docs