GitHub 통합

GitBook 은 책의 소스에 대한 호스팅으로 GitHub 와 완벽하게 통합합니다.

계정 연결 / 권한

책을 GitHub 와 통합하기전에, GitHub 계정에 대해 접근하기 위해 GitBook 권한을 부여해야합니다.

Account Settings에서, 올바른 사용 권한으로 GitHub 계정을 연결하세요:

  • 기본 사용 권한: 로그인 중에만 GitHub 계정에 인증합니다.
  • 웹훅 접근: GitHub 계정에 접근하기 위해 지정된 저장소에 웹훅을 만드세요 (웹훅을 보세요).
  • 공개 저장소 접근: 웹 편집기에서 GitHub 저장소에 접근할 수 있습니다. GitBook 에서 책을 쉽게 편집할 수 있습니다. (공개 저장소만 가능)
  • 비공개 저장소 접근: 위와 같으며 비공개 저장소에도 접근할 수 있습니다.

GitHub 에서 책 가져오기

새 책을 만들때, GitHub 탭에서 가져올 GitHub 저장소를 선택할 수 있습니다.

새로 생성된 책은 저장소의 콘텐츠와 함께 설정되고, 웹훅이 자동으로 추가됩니다.

웹훅

GitHub 저장소가 변경될 때 웹훅이 GitBook 에 알려줍니다.

GitHub 변경을 GitBook 에서 사용할 수 없다면, 문제의 주된 원인은 웹훅입니다. 저장소의 설정에서 웹훅의 상태를 확인하세요.

책과 GitHub 저장소 연결

GitHub 계정이 GitBook 계정과 제대로 연결되었다면, 책과 저장소 연결은 간단합니다.

주의: 책의 설정에서 GitHub 저장소를 지정하면, 그것은 GitBook 의 git 저장소에 우선 적용됩니다. 이 편집기가 직접 GitHub 의 콘텐츠를 편집할 것을 의미합니다.

동기화는 단방향입니다. GitHub 의 변경사항만이 GitBook 의 빌드를 발생시킵니다. GitBook 은 이전에 작성된 어떠한 내용도 GitHub 저장소에 반영하지 않을 것 입니다.

  1. 책 설정에서 GitHub 절을 엽니다
  2. 저장소 ID 를 입력합니다 (다음과 같은: YourGitHubUserName/RepoName)
  3. 설정을 저장합니다
  4. Add a deployment webhook 버튼을 누르세요

(올바른 권한을 승인받은 경우) 이제 웹 편집기에서 GitHub 저장소를 편집할 수 있습니다. 그리고 GitHub 의 커밋은 GitBook 의 빌드를 발생시킬 것 입니다.

일반적인 오류:

내 책이 갱신되지 않습니다 / 어떠한 빌드도 볼 수 없습니다

GitHub 저장소를 GitBook 에 연결하였음에도 컨텐츠 편집이 빌드를 발생하지않습니다. GitHub 저장소에 웹훅이 올바르게 추가되었는지 확인합니다 (GitHub 저장소 설정 -> 웹훅). 웹훅이 없거나 유효하지 않은경우, 책의 설정에서 다시 추가하세요.

책 이름/소유자의 변경

책을 새 소유자에게 전달하면, 이제 웹훅은 유효하지 않습니다. 그것을 다시 추가해야 합니다.