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

   Переключитесь на указанную в проекте версию Node с помощью nvm

   nvm use
3. 3

   Установите зависимости с помощью Bun

   bun install
4. 4

   Запустите локальный сервер разработки

   bun dev

Что важно знать

• !Требуются Node.js версии 22.3 или выше и Bun версии 1.2.15 или выше.
• !Проект распространяется по лицензии GPL-3.0, поэтому для распространения изменённого кода необходимо открыть исходный код или приобрести коммерческую лицензию.
• !В README не рекомендуется самостоятельный хостинг, а сопровождающие не гарантируют поддержку форков.

Темы

Частые вопросы

Что такое gitbook?

Open source-движок рендеринга на Next.js для опубликованных сайтов документации GitBook с возможностью самостоятельного хостинга. GitBook — платформа для управления техническими знаниями команд. В этом репозитории находится open source-фронтенд, который отображает опубликованный контент GitBook. Благодаря ему сайт документации, созданный в GitBook, можно показывать с помощью этого кода.

gitbook можно использовать бесплатно? Какая у него лицензия?

gitbook распространяется с открытым исходным кодом под лицензией GPL-3.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

gitbook всё ещё поддерживается?

Активно поддерживается. Последний коммит в gitbook — 21 окт. 2026 г..

Для чего можно использовать gitbook?

Самостоятельно хостить опубликованный сайт GitBook на собственном домене. Встраивать документацию, отображаемую GitBook, в собственное приложение. Настраивать внешний вид опубликованной документации. Вносить исправления или переводы в движок рендеринга GitBook.

Как установить gitbook?

Клонируйте репозиторий: git clone https://github.com/gitbookIO/gitbook.git Переключитесь на указанную в проекте версию Node с помощью nvm: nvm use Установите зависимости с помощью Bun: bun install Запустите локальный сервер разработки: bun dev

Где скачать gitbook?

Исходный код и инструкции по установке — на GitHub: https://github.com/GitbookIO/gitbook