GitbookIO/gitbook

어떤 프로젝트인가요?

핵심 기능

• 01소스 코드에서 GitBook에 게시된 문서 사이트를 렌더링합니다.
• 02Next.js와 TypeScript를 기반으로 구축되었습니다.
• 03게시된 모든 GitBook 스페이스를 열 수 있는 로컬 개발 서버를 제공합니다.
• 04디자인과 외관을 맞춤 설정할 수 있는 자체 호스팅을 지원합니다.
• 05GitBook UI 번역 파일을 포함합니다.

활용 사례

• GitBook에 게시된 사이트를 자체 도메인에서 자체 호스팅하기.
• GitBook으로 렌더링한 문서를 자체 애플리케이션에 임베드하기.
• 게시된 문서의 외관을 맞춤 설정하기.
• GitBook 렌더링 엔진에 수정 사항이나 번역을 기여하기.

빠른 시작

1. 1

   저장소를 클론합니다

   git clone https://github.com/gitbookIO/gitbook.git
2. 2

   nvm으로 프로젝트에서 지정한 Node 버전으로 전환합니다

   nvm use
3. 3

   Bun으로 종속성을 설치합니다

   bun install
4. 4

   로컬 개발 서버를 시작합니다

   bun dev

사용 전 알아둘 점

• !Node.js 22.3 이상과 Bun 1.2.15 이상이 필요합니다.
• !GPL-3.0 라이선스가 적용되므로 수정한 코드를 배포하려면 소스 코드를 공개하거나 상용 라이선스를 구매해야 합니다.
• !README에서는 셀프 호스팅을 권장하지 않으며, 유지 관리자는 포크에 대한 지원을 보장하지 않습니다.

토픽

자주 묻는 질문

gitbook은(는) 무엇인가요?

GitBook에서 게시한 문서 사이트를 제공하고 선택적으로 자체 호스팅할 수 있는 오픈 소스 Next.js 렌더링 엔진입니다. GitBook은 팀의 기술 지식을 관리하는 플랫폼입니다. 이 저장소에는 GitBook에 게시된 콘텐츠를 렌더링하는 오픈 소스 프런트엔드가 포함되어 있어, GitBook으로 만든 문서 사이트를 이 코드로 표시할 수 있습니다.

gitbook은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

gitbook은(는) GPL-3.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

gitbook은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. gitbook의 마지막 커밋은 2026년 10월 21일입니다.

gitbook은(는) 어디에 사용할 수 있나요?

GitBook에 게시된 사이트를 자체 도메인에서 자체 호스팅하기. GitBook으로 렌더링한 문서를 자체 애플리케이션에 임베드하기. 게시된 문서의 외관을 맞춤 설정하기. GitBook 렌더링 엔진에 수정 사항이나 번역을 기여하기.

gitbook는 어떻게 설치하나요?

저장소를 클론합니다: git clone https://github.com/gitbookIO/gitbook.git nvm으로 프로젝트에서 지정한 Node 버전으로 전환합니다: nvm use Bun으로 종속성을 설치합니다: bun install 로컬 개발 서버를 시작합니다: bun dev

gitbook은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/GitbookIO/gitbook