2020 사제동행세미나
지식 공유
목차
1. GitBook 이란?
2. GitBook 사용방법
3. GitBook 장점
4. GitBook 예시
- GitBook 이란?
우리가 아는 git ➡ 버전 관리 시스템
그럼 GitBook ➡ 마크다운 기반의 문서 작업 사이트
처음 프레임워크, 오픈소스들을 익힐 때 공식 사이트를 통해 매뉴얼을 익혔을 겁니다. 위의 chart.js 매뉴얼이 GitBook으로 작성되고 배포된 하나의 예시입니다.
프로젝트를 만들 때 GitHub에 소스코드, README.md 문서만 게시하는 것이 아니라 프로젝트에 대한 소개와 설명, 매뉴얼을 위한 공식 사이트를 만듭니다. 사이트를 만들 때 직접 웹사이트를 구축하거나 블로그를 많이 사용합니다. GitBook도 그 하나의 예시입니다. - GitBook 사용법
GitBook의 사용법은 아주 간단합니다.
gitbook.com에서 회원가입을 합니다. 보통 나중에 자신의 github에 gitbook의 내용을 담을 수 있어서 GitHub의 계정으로 연동을 합니다.
기관인 Organization을 생성합니다. 나중에 만든 gitbook의 url에 organization의 이름이 포함됩니다.
용도를 선택합니다. 원하는 용도를 선택해서 사용하시면 됩니다.
타이틀과 공개범위를 설정합니다. 타이틀은 나중에 생성된 자신의 gitbook의 타이틀이 되고 url에 포함됩니다.
생성된 gitbook 페이지 입니다.
보시는 거와 같이 제목, 설명, 본문, 템플릿선택 으로 이루어져 있습니다. - GitBook 장점
- 손쉬운 사용
마크다운 기반의 문서 손쉬운 사용 – 마크다운 기반 문서 작업 - Git과 연동
gitbook에서 작업한 내용을 git repository에 올라감
(메인 페이지는 README.md가 되고 나머지 페이지들은 summary.md로 올라감) - 공유 작업이 편리
git처럼 팀원을 추가해 같이 문서작업을 할 수 있음 - 확장 – slack, github, intercom 등과 통합이 가능
- GitBook 예시
제가 올해 오픈소스 개발자 대회를 준비하면서 만든 오픈소스 프로젝트의 매뉴얼입니다.
-
소감
제 GitBook 사용 소감은 다음과 같습니다.아주 편리하게 제 프로젝트에 대한 매뉴얼을 작성할 수 있었다.
사실 GitBook의 용도는 다양합니다. 하지만 가장 많이 사용할 수 있는 용도가 바로 매뉴얼 작성이라고 생각해서 소개하게 되었습니다.
프로젝트를 만들고 github에 README.md 문서에 간단하게 설명하는 것이 아니라 직접 매뉴얼 사이트를 만들어 자신의 프로젝트를 설명할 수 있는 것 또한 중요하다고 생각했습니다.
여러분도 프로젝트를 만들고 다른 사람들을 위한 매뉴얼을 작성하실 때 GitBook을 고려해보셨으면 좋겠습니다.
