Gitbook을 사용하여 간단한 내부 위키를 만드는 방법

Gitbook을 사용하여 간단한 내부 위키를 만드는 방법

GitBook은 문서 사이트 또는 회사 위키를 구축할 수 있는 플랫폼입니다. 코드에서 API 및 소프트웨어 제품 사용 방법에 이르기까지 모든 종류의 항목을 문서화하는 데 사용할 수 있습니다.



GitBook은 GitHub 리포지토리와 유사한 프로세스를 사용합니다. 문서의 기본 복사본은 '마스터' 복사본 역할을 합니다. 그런 다음 '분기'와 유사한 '초안'을 만들 수 있습니다.





Windows 10이 표시되지 않는 외장 드라이브

이 프로세스를 통해 많은 사용자가 충돌을 처리하거나 방지하면서 단일 문서 사이트에서 작업할 수 있습니다. 또한 다른 브랜치의 변경 사항을 병합하기 전에 검토 프로세스를 거치도록 허용합니다.





GitBook 사용을 시작하는 방법

여러 가지 중에서 선택할 수 있습니다. GitBook 가격 계획. 가격은 오픈 소스 프로젝트, 개인용 또는 개인 팀 협업을 위해 GitBook을 사용하는지 여부에 따라 달라집니다. GitBook은 오픈 소스 프로젝트에 사용하는 경우 무료로 사용할 수 있습니다.

GitBook 지원 많은 이점을 제공하는 인기 있는 마크업 언어인 마크다운 웹에서 작성하거나 문서화하기 위한 것입니다.



더 저렴한 우버나 리프트

GitBook은 다음과도 통합됩니다. 코드 호스팅, 저장 및 편집을 위한 플랫폼인 GitHub . GitHub 자격 증명을 사용하여 로그인하여 GitBook 계정을 GitHub 계정에 직접 연결할 수 있습니다.

  1. GitBook에 가입하십시오. 자신의 GitHub 계정이 있는 경우 다음을 클릭할 수 있습니다. GitHub에 가입 .
  2. 로그인하면 GitBook이 새로운 내부 위키로 리디렉션합니다. 또한 일부 샘플 콘텐츠로 Wiki를 미리 채웁니다.

GitBook 인터페이스 개요

GitBook에는 문서 사이트를 빌드하고 변경할 수 있는 여러 기능이 있습니다.





  1. 상단 패널에서 새 초안을 작성하거나 변경 내역을 보거나 다른 토론이나 첨부 파일을 볼 수 있습니다.
  2. 가장 왼쪽 사이드바를 사용하면 여러 공간을 만들 수 있습니다. 문서 영역을 분리하고 구성할 수 있도록 다른 프로젝트에 별도의 공간을 사용할 수 있습니다. 사이드바를 확장하거나 닫을 수 있습니다.
  3. 왼쪽 패널은 문서 사이트의 메뉴 역할을 합니다. 문서 사이트 내에서 페이지를 보고 그룹 및 중첩 페이지를 만드는 데 사용할 수 있습니다. 제공된 링크를 사용하여 사이트를 탐색할 수도 있습니다.
  4. 하단 패널에는 버전 관리 프로세스에 필수적인 버튼이 있습니다. 초안의 이름을 추가하거나 변경 사항을 병합하거나 검토를 위해 변경 사항을 제출할 수 있습니다.

새 초안을 만드는 방법

새 변경 요청을 만들고 그 안에서 변경하여 새 초안을 만들 수 있습니다.

  1. 상단 패널에서 변경 요청 .
  2. 오른쪽에 나타나는 새 패널에서 초안 탭. 그러면 활성 초안이 모두 표시됩니다.
  3. 여기에서 기존 초안을 클릭하여 열 수 있습니다. 새 초안을 만들려면 새로운 변경 요청 , 페이지 로드가 완료될 때까지 기다립니다.
  4. 하단 패널에서 제목 입력 . 그러면 새 초안에 이름을 지정할 수 있는 창이 열립니다. 예를 들어, 새 페이지 - 코드베이스 설정 방법 .

페이지 및 그룹을 만드는 방법

초안이 있으면 문서 변경을 시작할 수 있습니다. GitBook은 변경 사항을 초안에 저장하므로 마스터 사본에 영향을 미치지 않습니다. 왼쪽 사이드바를 사용하여 페이지 및 페이지 그룹을 추가할 수 있습니다.





  1. 클릭하여 새 페이지 만들기 새 페이지 사이드바 하단에 있는 링크를 클릭하고 새 문서 페이지 드롭다운에서. 또는 기존 페이지 아래에 마우스를 놓고 파란색 ...을 더한 단추.
  2. 새 페이지 그룹을 만들려면 새 페이지 를 선택하고 새 그룹 드롭다운에서 옵션을 선택합니다.
  3. 페이지 또는 그룹 옆에 있는 세 개의 점을 클릭하고 다음을 선택하여 페이지 이름을 변경할 수 있습니다. 이름 바꾸기 .
  4. 콘텐츠를 추가하여 새 페이지를 채우십시오. 텍스트나 제목과 같은 간단한 콘텐츠를 추가할 수 있습니다. GitBook을 사용하면 이미지, 첨부 파일, 테이블, 탭 또는 코드 조각과 같은 다른 콘텐츠 블록을 추가할 수도 있습니다. YouTube 포함 또는 Google 문서도구 콘텐츠와 같은 다른 통합을 추가하는 옵션도 있습니다.
  5. 클릭 차이 보기 버튼을 눌러 초안과 원본 마스터 문서 사본 간의 차이점을 확인합니다.
  6. 내용 작성을 마치면 다음을 클릭할 수 있습니다. 병합 , 제출 및 병합 , 또는 검토를 위해 제출 .

GitBook의 상단 패널에서 공유 링크에 액세스할 수 있습니다. 링크를 보려면 초안에서 나와 마스터 문서 사본을 확인해야 합니다.

  1. 기본적으로 문서 사이트의 가시성은 '목록에 없음'입니다. 즉, 검색 엔진이 아닌 개인 링크를 사용하여 문서 사이트에 액세스할 수 있습니다. 상단 패널에서 미등록 단추.
  2. 드롭다운에서 원하는 가시성 설정을 선택합니다. GitBook은 특정 가시성 설정을 잠글 수 있으며 액세스하려면 업그레이드해야 할 수 있습니다.
  3. 가시성 설정 목록 아래에는 문서 사이트를 사용할 다른 사용자와 공유할 수 있는 링크가 있습니다. 다른 사람과 공유하려면 이 링크를 복사하세요.
  4. 링크 아래에 있는 링크 및 도메인 설정 . 여기에서 사용자 정의 도메인 이름을 연결하거나 URL의 일부를 수정할 수 있습니다. 사용자 정의 도메인을 사용하는 경우 다음을 볼 수 있습니다. Gitbook의 문서 DNS를 올바르게 구성하는 방법에 대해 설명합니다.

GitBook을 사용하여 문서 만들기

GitBook을 사용하면 문서 사이트 또는 회사 Wiki를 공동으로 만들고 작업할 수 있습니다. GitBook은 분기 및 병합과 같은 GitHub의 개념을 차용하여 마스터 사본을 제어하고 충돌을 관리합니다.

비활성화된 페이스북 계정으로 메시지 보낼 수 있어

새 초안을 만들어 문서에 개별 변경 사항을 추가할 수 있습니다. 초안 내에서 콘텐츠를 변경하고 새 페이지 또는 페이지 그룹을 추가할 수 있습니다. 변경을 완료하면 병합하거나 검토를 위해 제출할 수 있습니다.

Java 코드에 대한 내부 문서를 작성하는 경우 Javadoc을 탐색할 수 있습니다. Javadoc을 사용하면 Java 코드를 자동으로 문서화할 수 있습니다.