GitbookIO/gitbook

これは何？

主な機能

• 01GitBookの公開ドキュメントサイトをソースコードからレンダリングします。
• 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