GitBook + GitHub로 개발 노트 관리하기

GitHub에 학습 기록을 정리하는 분들을 보면서

나도 공부한 내용을 GitHub에 남겨보고 싶다는 생각이 들었다.

 

들었던 강의나 읽었던 책의 내용을 README로 정리하는 방법도 떠올랐지만,

조금 더 가독성 있고 나중에 다시 찾아보기 쉬운 형태로 정리하고 싶다는 고민이 있었다.

 

그러던 중 GitBook이라는 도구를 알게 되었고,

GitBook으로 문서를 정리하면서 GitHub와 연동해

기록을 남기는 방식이 좋아 보여서 두 도구를 함께 사용해보기로 했다.

 

그 과정을 간단하게 글로 남겨보려고 한다.

 

1. GitHub 레포지토리 생성

먼저 GitBook과 연동할 GitHub 레포지토리를 생성했다.

 

2. GitBook Space 생성

GitHub 레포지토리를 생성하고

실제 문서를 작성할 GitBook Space를 생성했다.

 

GitBook에 접속한 뒤 새로운 Space를 만들고

템플릿은 무난한 Blank로 선택했다.

 

3. GitBook과 GitHub 연동하기

GitBook Space를 생성한 뒤에

상단의 Set up Git Sync 버튼을 눌러서 GitHub 연동을 진행했다.

 

순서대로 진행하면 되는데

한 가지 유의할 점은 GitBook GitHub App을 설치하지 않으면

레포지토리가 목록에 보이지 않는다.

처음에는 이 부분을 몰라 잠시 헤맸다...🥲

 

Install GitHub App 버튼을 통해

연동할 레포지토리에 대한 접근 권한을 추가해주면

정상적으로 레포지토리가 표시된다.

 

4. Git Sync 설정 옵션

설치 후 다시 GitBook으로 돌아오면

연동할 GitHub 계정, 레포지토리, 브랜치를 선택할 수 있다.

 

앞에서 GitBook GitHub App을 설치했던

레포지토리를 선택해 연결해주었다.

 

스크롤을 내려보면

GitBook에서 생성되는 커밋 메시지 형식을

직접 설정할 수 있는 옵션도 있다.

 

마지막으로 Initial Sync 옵션을 설정해야 한다.

GitBook에서 초기 구조를 만들 생각이어서

GitBook to GitHub 옵션을 선택했다.

 

5. GitBook 작성하기

edit 버튼을 누른 뒤에 원하는 내용을 작성하고

Merge 버튼을 누르면 GitHub에 커밋이 생성된다.

 

레포지토리를 확인해보면 잘 연동된걸 확인할 수 있다.

 

6. Gitbook 배포하기

GitBook에서는 작성한 문서를 간단하게 배포할 수 있다.

도메인, 테마 등 커스텀하고 싶은 설정이 있다면  
설정을 추가한 뒤 `Publish` 버튼을 누르면  
별도의 배포 과정 없이 바로 문서를 공개할 수 있다.

 

---

 

이번 글에서는 GitBook과 GitHub를 연동하는 과정만 정리해보았다.

이제 남은 건 열심히 정리하는 일뿐... 파이팅💪

 

 

배포 사이트

https://ahreum.gitbook.io/dev-reading-notes/

Dev Reading Notes

 

 

레포지토리

https://github.com/aahreum/dev-reading-notes

GitHub - aahreum/dev-reading-notes