GitbookIO/gitbook

这是什么？

核心功能

• 01基于源码渲染 GitBook 已发布的文档站点。
• 02采用 Next.js 与 TypeScript 构建。
• 03提供本地开发服务，可访问任意已发布的 GitBook 空间。
• 04支持自部署，并可定制页面外观。
• 05包含 GitBook 界面的多语言翻译文件。

适用场景

• 在自有域名下自部署 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 是什么？

开源的 Next.js 渲染引擎，用于呈现 GitBook 已发布的文档站点，也可自行部署。 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