[gitbook]프로젝트나 기획 docs 만드는 솔루션 gitbook - none legacy gitbook

요즘 개발을 한다고하면 github, gitbook, slack을 사용한다.

그 중에서 gitbook은 document를 담당한다.

즉 특정 프로젝트의 명세나 사용법, 로그등등을 기록하는 것이다.

이는 github만으로도 할 순 있지만 체계화 시켜주면서 더 좋아졌다.

gitbook은 레거시 버전과 현재 버전이 있으며 레거시와 현재버전은

사용방식도, 보여지는 방식도, 심지어 아이디마저도 다르다.

여기서는 레거시 방식이 아닌 최신 버전을 언급하겠다.

Gitbook과 Legacy Gitbook

https://www.gitbook.com

검정색의 깃헙과는 달리 깃북은 푸르딩딩한 느낌이다.

https://legacy.gitbook.com

이 사이트는 레거시 깃북이다. 둘은 이름만 같지 쓰는 느낌이 매우 다르니 취향에 맞게 선택한다.

레거시 깃북이 조금더 자유로운 느낌이긴한데 간편한건 현재 깃북이다.

필자는 무조건 현재 깃북버전으로 사용할 것이다.

그럼 한번 사용해 보도록하자.

회원가입

일단 사용하려면 당연히 회원가입을 해야한다.

보통의 경우 github아이디와 연동해서 사용하므로 우리도 깃헙과 연동하자.

문서 만들기

로그인이 끝났으면 문서를 만들자.

문서는 마들기 전에 기관(Organization)을 만들어야한다.

일단 먼저 기관이름을 적는다.

기관 이름을 적고나면 기관 url을 지정한다. 보통 기관이름 그대로 쓴다.

그 다음 프로젝트명을 쓴다.

그 다음 프로젝트의 공개상태를 설정한다.

완성된다.

완성되면 위와 같은 페이지가 만들어진다.

메인페이지 수정 및 작성

문서는 수정을 눌려야 수정이 시작된다. 우측의 Edit this page나 아래페이지의 Edit을 눌러준다.

저기 동그라미 친 부분을 누르면된다.

문서의 수정페이지로 넘어오면 메인 페이지를 수정할 수 있다.

크게 보면 3부분인데 바로 제목, 설명, 본문이며 본문의 경우에 템플릿을 사용하여표시할수 있다.

새 페이지 만들기

새 페이지를 만들기 위해서는 좌측상단의 +Add New Page를 눌러준다.

그러면 메인 페이지처럼 작성할 수있다. 방식은 똑같다.

페이지는 만드시 문서로만 작성하는게 아니라 그룹이나 링크로도 만들 수있다.

마우스를 올리면 뜨는 ...을 클릭하면 링크나 그룹 중 선택할 수 있다.

그룹 만들기

그룹은 만들고나서 그룹내에서 새 페이지를 만들고 싶으면 ...을 클릭한다.

그러면 새로운 페이지나 링크를 추가할 수있다.

링크 만들기

링크는 ...을 눌러준뒤 링크만들기를 누르면 URL입력이 뜬다.

그다음 링크를 입력하면 화살표가 뜬다 눌러준다.

그러면 링크의 이름을 정할 수있다.

링크의 이름 역시 지정해 준다.

링크가 추가된걸 확인할 수 있다.

Draft와 Publish

깃을 기반으로 했기에 commit과 push같은 개념이 있다.

바로 Draft와 Publish이다.

하단을 보면 Save as Draft와 Publish가 뜬다.

Publish는 바로 Push를 하는것이다.

한번 Draft를 눌러보자.

드래프트의 이름을 정할 수있다.

화살표를 누르면 현재 Draft목록을 볼 수 있다.

이걸로 현재 문서와 비교도 가능하다. published는 지금 당장의 문서이다.

드래프트 버전을 누른후 Publish를 누르면 Push가된다.

draft를 publish할경우 물어보는데 승인을 눌러주면 퍼블리싱된다.