GitBook 연동
화면 녹화로 GitBook에 단계별 가이드 게시하기
기능을 화면에서 한 번만 보여주세요. Clevera가 스크린샷이 포함된 사용법 페이지를 작성하고, GitBook의 자체 블록으로 구성된 힌트, 스텝퍼, 탭, 확장형 블록을 사용하여 선택한 GitBook 스페이스에 게시합니다.
네이티브 GitBook 블록
스페이스에 업로드된 이미지
동일한 페이지 업데이트
모든 GitBook 플랜 지원
활용 방법
모든 릴리스에 맞춰 업데이트되는 제품 문서,
페이지마다 작성자가 필요하지 않습니다.
개발 및 제품 팀이 GitBook을 선택하는 이유는 보기 좋고 체계적으로 유지되기 때문입니다. 하지만 GitBook은 직접 페이지를 작성해주지는 않습니다. Clevera는 제품 녹화본을 바탕으로 명확하고 일러스트가 포함된 사용법 가이드를 작성하여 스페이스를 채워줍니다.
기능별 사용법 페이지
출시한 기능을 녹화하세요. Clevera가 소개, 번호가 매겨진 단계, 각 단계별 스크린샷, 독자에게 필요한 팁을 포함한 페이지를 작성합니다.
텍스트 붙여넣기가 아닌 GitBook 블록
단계는 GitBook 스텝퍼로, 콜아웃은 힌트로, 탭은 그대로 유지되며, 코드 블록은 언어와 제목이 보존됩니다. 팀이 GitBook에서 직접 작성한 것과 같은 페이지가 완성됩니다.
GitBook에 저장되는 스크린샷
모든 스크린샷은 파일로 스페이스에 업로드되므로, Clevera에서 원본 아티클이 삭제되어도 페이지는 정상적으로 작동합니다.
UI 변경 시 재녹화
Clevera에서 아티클을 수정하고 다시 게시하세요. Clevera가 해당 페이지를 찾아 제자리에서 업데이트하므로 주소와 링크가 그대로 유지됩니다.
언어별 스페이스
Clevera에서 아티클을 번역하고 에디터에서 언어를 전환한 뒤, 각 버전을 해당 언어의 스페이스에 게시하세요.
원하는 스페이스 선택
Clevera는 GitBook에서 생성한 개인 액세스 키로 연결되며, 게시할 문서 사이트를 직접 선택할 수 있습니다.
작동 방식
녹화에서 GitBook 페이지까지
4단계로 완료.
GitBook 키를 한 번만 붙여넣으세요. 그 후에는 워크스페이스의 모든 아티클을 문서 페이지로 만들 수 있습니다.
- 1
키로 연결
GitBook의 개발자 설정에서 개인 액세스 토큰을 생성하여 Clevera에 붙여넣고 사이트를 선택하세요. - 2
Clevera가 페이지 작성
화면 녹화본을 바탕으로 Clevera가 제목, 단계, 힌트, 스크린샷을 포함한 사용법을 작성합니다. - 3
스페이스 선택 및 게시
공유(Share)에서 게시(Publish)를 열고, GitBook 스페이스를 선택한 뒤 'GitBook에 게시'를 클릭하세요. - 4
문서에 바로 적용
게시가 완료되면 이미지와 함께 페이지가 스페이스 최상단에 나타납니다.
Clevera에서 확인
GitBook에 게시하기,
아티클 공유 창에서 바로.
마크다운 내보내기, 이미지 재업로드, GitBook 에디터에서 단계를 수동으로 다시 만들 필요가 없습니다. 링크와 임베드 코드를 제공하는 공유 창에서 바로 GitBook에 게시할 수 있습니다.
키로 연결, 저장 전 확인
GitBook 개인 액세스 토큰을 붙여넣고 다음을 클릭하세요. 키 확인. Clevera는 저장 전 GitBook과 연결을 테스트한 뒤, 선택된 모든 문서 사이트 목록을 보여줍니다. Clevera가 접근하지 않길 원하는 사이트는 체크를 해제하세요.
이 키는 키를 생성한 GitBook 사용자의 권한으로 작동합니다. 공유 문서 계정을 사용하면 팀원이 변경되어도 게시 기능이 유지됩니다.
페이지가 들어갈 스페이스 선택
목록에는 제품 문서나 API 문서와 같이 선택한 사이트의 스페이스가 표시됩니다. 하나를 선택하여 게시하세요. Clevera가 해당 페이지가 이미 존재하는지 먼저 확인합니다.
페이지 주소는 제목을 따르므로, “팀 초대하기”는 다음과 같이 됩니다. /invite-your-team. 원할 때 언제든 GitBook에서 이동하거나 이름을 변경하세요.
자동 완성
아티클이 GitBook 페이지가 되는 과정
블록 단위로 구성됩니다.
Clevera는 GitBook의 자체 문서 블록을 사용하여 페이지를 구성하므로 스페이스의 다른 페이지처럼 편집할 수 있습니다. 각 게시물에 포함되는 내용은 다음과 같습니다.
- 스페이스직접 선택
- 연결 시 선택한 문서 사이트의 모든 스페이스. 언제든지 다음을 통해 사이트를 변경할 수 있습니다. 재연결.
- 페이지 제목 및 주소자동 설정
- 아티클 제목과 이를 바탕으로 생성된 주소가 스페이스 최상단에 설정됩니다. 악센트가 있거나 다른 문자로 된 제목은 라틴 문자로 먼저 표기됩니다.
- 단계자동 변환
- 번호가 매겨진 단계는 GitBook 스텝퍼로 변환되며, 아티클의 각 단계가 GitBook의 한 단계가 됩니다.
- 콜아웃자동 변환
- 힌트 블록: info와 note는 Info로, tip과 success는 Success로, warning은 Warning으로, danger는 Danger로 변환됩니다.
- 탭, 토글 및 코드자동 변환
- 탭은 GitBook 탭으로 유지되고, 접기 섹션은 확장형 블록이 되며, 코드 블록은 언어와 제목이 보존되고, 수식은 GitBook 수학 블록을 사용합니다.
- 스크린샷자동 설정
- 캡션과 함께 파일로 스페이스에 업로드됩니다.
- 동영상자동 설정
- 아티클에 포함된 동영상과 임베드는 GitBook 임베드 블록이 됩니다. Clevera 동영상은 공유 링크가 활성화된 경우 포함됩니다. 아티클의 원본 동영상은 추가되지 않습니다.
- 변경 요청자동 설정
- Clevera는 GitBook 변경 요청을 통해 페이지를 작성하고 즉시 병합하므로, 게시가 완료되면 페이지가 바로 라이브 상태가 됩니다.
설정
GitBook 연동 설정
약 2분 소요.
Pro 이상의 Clevera 워크스페이스와 모든 GitBook 플랜이 필요합니다. 워크스페이스 소유자나 관리자가 GitBook을 한 번 연결하면, 아티클 편집 권한이 있는 누구나 게시할 수 있습니다. 게시 시 크레딧은 차감되지 않습니다.
- 1
GitBook 액세스 키 생성
GitBook에서 계정 설정을 열고 다음으로 이동하세요. 개발자(Developer), “Clevera”라는 이름의 개인 액세스 토큰을 생성하고 복사하세요. GitBook은 이를 한 번만 보여줍니다. - 2
Clevera에서 GitBook 연결
워크스페이스 메뉴를 열고 다음을 선택하세요. 연동(Integrations), 다음을 찾으세요. GitBook 그리고 다음을 클릭하세요. 연결(Connect). 다음 항목에 키를 붙여넣으세요. 액세스 키(Access key) 그리고 다음을 클릭하세요. 키 확인. - 3
사이트 선택
다음 항목 아래에서 게시할 사이트(Sites to publish to), Clevera가 사용할 문서 사이트를 유지하고 다음을 클릭하세요. 연결(Connect). 스페이스가 아직 없나요? Clevera가 “Clevera”라는 이름의 스페이스를 생성해 드립니다. - 4
아티클 게시
아티클 에디터에서 다음을 클릭하세요. 공유(Share), 다음을 여세요. 게시(Publish), GitBook 타일을 클릭하고 스페이스를 선택한 뒤 다음을 클릭하세요. GitBook에 게시(Publish to GitBook). - 5
GitBook에서 열기
“GitBook에 게시되었습니다.”라는 메시지가 보이면 다음을 클릭하세요. GitBook에서 열기(Open in GitBook) 페이지를 확인하세요.
GitBook 연동 관련 질문
Clevera는 변경 요청을 열고 즉시 병합하므로 게시가 완료되는 즉시 페이지가 라이브 상태가 됩니다. 문서의 모든 변경 사항을 먼저 검토해야 한다면, 초안 스페이스에 게시한 후 승인되면 페이지를 이동시키세요.
선택한 스페이스의 최상단에 나타납니다. 이후 GitBook에서 적절한 그룹으로 이동하거나 상위 페이지 아래로 옮기고, 원한다면 이름을 변경하세요.
Clevera는 동일한 제목이나 주소를 가진 페이지를 찾아 어떻게 할지 묻습니다. 주소를 유지하면서 제목과 내용을 바꾸려면 업데이트하고, 새로운 제목으로 새 페이지를 만들 수도 있습니다. 업데이트 시 GitBook에서 수정한 내용은 덮어쓰기 되지만, GitBook 기록을 통해 복구할 수 있습니다.
아니요. 게시 작업은 Clevera에서 GitBook으로 향하는 단방향입니다. Clevera의 아티클을 원본으로 유지하고, 변경 사항이 있으면 다시 게시하세요.
Clevera 측에서는 만료되지 않습니다. 키는 생성한 GitBook 사용자에게 귀속되므로, 해당 사용자가 조직에 대한 액세스 권한을 잃으면 게시가 중단됩니다. GitBook의 개발자 페이지에서 키를 삭제하여 취소하세요.
아니요. 이 연동은 문서를 GitBook에 유지하면서 페이지를 추가하는 방식입니다. Clevera로 고객 센터를 운영하고 싶다면 다음을 확인하세요. 무료 GitBook 가져오기 및 Clevera와 GitBook 비교.
GitBook 게시 기능은 Clevera의 Pro 및 Custom 플랜에 포함되어 있으며 크레딧을 사용하지 않습니다. 아티클 작성 시에는 평소처럼 크레딧이 사용됩니다. 키를 생성한 사용자가 스페이스를 편집할 수 있다면 모든 GitBook 플랜에서 작동합니다. 다음을 확인하세요. 요금제.