はじめに

Guidebook Cloud は、開発者向けの社内ドキュメントホスティングサービスです。GitHubリポジトリと連携し、Markdown形式のドキュメントを自動的にビルド・公開できます。

Guidebook Cloudとは

Guidebook Cloudは、Guidebook（HonKit/GitBook互換の静的サイトジェネレーター）をクラウドで提供するサービスです。GitHubリポジトリにドキュメントをプッシュするだけで、自動的にビルドされ、チームメンバーに公開されます。

主な特徴

GitHubとのシームレスな連携

  • GitHubリポジトリと連携し、プッシュ時に自動デプロイ
  • ブランチごとのプレビュー環境
  • プルリクエストのプレビュー対応

アクセス制御

  • IPアドレスによるアクセス制限
  • チームベースの権限管理

HonKit/GitBook互換

  • 既存のHonKit/GitBookプロジェクトをそのまま利用可能
  • Markdown形式でドキュメントを記述
  • SUMMARYファイルによる目次管理

高速なビルド

  • Rustで実装された高速なビルドシステム
  • 変更があったファイルのみを効率的に処理

サービスURL

サービスURL
コンソールhttps://console.guidebook.dev
ドキュメント閲覧https://guidebook.dev/{org}/{repository}/{branch}/
APIhttps://api.guidebook.dev

はじめる

Guidebook Cloudを使い始めるには、クイックスタートガイドをご覧ください。