# gitbook

5개의 포스트
post-thumbnail

GitBook 사용법 정리

개요 UMC에서 간단한 블로그 CRUD를 만들라는 미션이 있었고, API 명세서를 작성해야 하는 필요가 있었다. 그런데 이번에는 저번 넘블 인스타그램 챌린지를 하면서 적용하고 싶었던 GitBook 도구를 활용하고 싶었고, 해당 작업을 하면서 알게 된 정보를 작성하려고 한다. GitBook 소개 GitBook은 개인, 팀이 문서화를 할 때 유용하게 사용할 수 있는 서비스이다. 많은 기능이 있지만, 일단은 API 명세서를 만들기까지의 과정을 보도록 하겠다. API 문서화 작성 절차 가입 우선 Sign up with GitHub를 클릭하면 다음과 같은 화면이 나온다. 깃허브를 통해서 인증한다. ![](https://

2023년 5월 13일
·
0개의 댓글
·
post-thumbnail

GitBook으로 Api 명세서 작성해보자

지난번에 Swagger를 통해 OpenAPI에 대한 specification을 작성하고, Swagger-UI를 통해 브라우저상에 띄우는 것을 해보았는데 이번엔 GitBook을 통해 Api 명세서를 작성해보자 왜 사용했는지? 사실 Swagger도 굉장히 편리했다. 특히, Nest에서 모듈로 제공하기 때문에 간편하게 코드로 작성할 수 있다는 장점이 있었지만... 규모가 커졌을 때 명세서를 작성하기 위한 코드량이 너무 길어질 것 같다는 점, GitBook을 보기 전까진 잘 못느꼈으나 Swagger-UI에 비해 UI가 더 보기 쉽고 사용하기 편할 것 같다는 점 때문에 기본적인 기능들만 사용을 해보았다. GitBook이란? 그래서 GitBook이라 하면 팀 내부에서의 기술 자료 및 API까지 모든 것을 문서화 할 수 있는 최신 문서화 플랫폼이다. GitBook은 md, html, docs와 같은 파일을 가져올 수

2023년 3월 9일
·
0개의 댓글
·

Gitbook - 블로그 문서화 플랫폼

gitbook? documentation 블로그 만드는 플랫폼 예시 사이트: http://soopsaram.com/ml gitbook 설치 gitbook 디렉토리 구조 생성 gitbook 서버 실행 그러면 localhost:4000 로 접속 가능. 생성된 디렉터리,파일 구조 기본 디렉터리 구조 SUMMARY.md 목차 생성 파일 > README.md 파일 하나로 목차 생성함. README.md SUMARY.md 간단한 예시 > tab으로 들여쓰기 하면 목차도 들여쓰기로 생성됨. 이

2022년 3월 23일
·
0개의 댓글
·
post-thumbnail

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

📚GitBook이란? GitBook 공식문서 GitBook이란, 공식문서에 따르면 제품에서 내부 지식 기반 및 API에 이르기까지 모든 것을 문서화 할 수 있는 최신 문서 플랫폼 이라고 한다. (구글번역에 따르면...) 처음 GitBook에 가입하고 대시보드에 들어가면 다양한 문서작성을 위한 템플릿을 제공하는데 나는 그것들을 사용하지는 않고 Github저장소에 있는 내 마크다운 문서들을 연동하여 Publish 하기 위해 사용하였다. 🔑Github저장소와 연동하는 방법 연동하는 방법은 매우 간단하다. GitBook에 들어가 로그인 한 후 대시보드에 진입한다. 아래와 같이 왼쪽 상단에 있는 플러스 버튼을 클릭해 New Space를 생성한다. ![](https://images.velog.io/images/kyz0111/post/a777e6

2022년 2월 28일
·
1개의 댓글
·
post-thumbnail

컨플루언스/깃북/노션

웹 가이드를 작성 및 공유하기 위해 3가지의 목표로 쪼개어 작업하려 한다. > 1차 - 공통화 및 자산 누적 2차 - 내부 공유 및 공통 업로드 작업(툴이용 한곳에서 관리) 3차 - 자산화(자체시스템) 1차적으로는 공통화 및 자산 누적을 위한 작업으로 velog를 통한 mark down 언어로 작성을 하였고 typora나 macdown프로그램으로 pdf 또는 html 파일로 export 작업을 했었다. 한계점은 velog의 공개/비공개 두가지 설정뿐이라는 점이 내부에서만 공유하기엔 한계가 있기 때문에 2차로 넘어가기 위해 아래와 같은 에디터를 사용하기 위해 조사해보았다. > 웹 가이드를 작성 및 공유하기 위해 알아본 에이터들이다. notion(노션) : https://www.notion.so/product confluence(컨플리언스) : https://gractor0ux.atlassian.net/wiki

2021년 5월 31일
·
0개의 댓글
·