GitBook과 Github저장소 연동하기(feat. TIL)

📚GitBook이란?

• GitBook 공식문서

GitBook이란, 공식문서에 따르면 제품에서 내부 지식 기반 및 API에 이르기까지 모든 것을 문서화 할 수 있는 최신 문서 플랫폼 이라고 한다. (구글번역에 따르면...)

처음 GitBook에 가입하고 대시보드에 들어가면 다양한 문서작성을 위한 템플릿을 제공하는데 나는 그것들을 사용하지는 않고 Github저장소에 있는 내 마크다운 문서들을 연동하여 Publish 하기 위해 사용하였다.

🔑Github저장소와 연동하는 방법

연동하는 방법은 매우 간단하다.

1. GitBook에 들어가 로그인 한 후 대시보드에 진입한다.

2. 아래와 같이 왼쪽 상단에 있는 플러스 버튼을 클릭해 New Space를 생성한다.
   

3. 아래와 같이 오른쪽 상단에 있는 옵션 버튼을 클릭해 Synchronize With Git 메뉴로 진입한다.
   

4. configure 클릭
   

5. Connect with GitHub 클릭
   

6. 성공적으로 연동이 되면 아래와 같이 나의 GitHub계정을 선택할 수 있게 된다.
   

7. 이미지가 조금 짤렸지만 위에서 계정을 선택하고 나면 내 GitHub저장소들을 확인할 수 있고 그 중 원하는 저장소를 선택한 뒤 아래 이미지와 같이 필요한 옵션들을 선택하고 Synchronize를 클릭하면 된다.
   

8. 이후 오른쪽 상단의 Publish 버튼을 클릭하면 웹을 통해 해당 저장소 문서들을 확인할 수 있다.(나는 이미 누른 뒤라 Public이라고 뜬다) But 목차를 작성해 주지 않으면 아래 처럼 폴더 별로 묶여 나오는 것이 아니라 모든 문서가 하나하나 쪼개져서 보이게 된다.
   

9. 해당 저장소 내에서 SUMMARY.md 파일을 만들고 아래 문서를 참고하여 작성하고 푸시해준다.
   GitBook 공식문서 Summary 작성

   🚧참고
   폴더별로 묶어주기 위해서는 폴더별로 README.md가 생성되어 있어야 한다.
   중간에 아무런 기능이 없는, 구분을 위한 제목을 넣고 싶을 때는 #을 이용한다.
   폴더 내에서 비슷한 문서끼리 묶어주고 싶을때는 아무런 링크 없이 소제목을 작성해주고 하위 항목으로 문서들의 링크를 넣어준다.

10. 푸시만 해주면 저장소와 연동되어 있기 때문에 GitBook으로 만든 페이지에는 자동으로 반영이 된다.

📑완료

모든 작업을 완료하고 나면 아래와 같은 나만의 TIL 페이지를 얻을 수 있다.
기존 Github에서 작성했을 때는 README.md 파일에 직접 하나하나 링크를 달아주었는데 이것도 뭐 summary를 작성해 줘야하긴 하지만 훨씬 깔끔하고 정리된 페이지를 볼 수 있어서 좋다. 검색도 가능하다!

아주 간단한 내용이지만 누군가에게 도움이 되길 바라며 작성해보았다😊

https://codekyz0111.gitbook.io/today-i-learned/