Introduction

Guidebook Cloud is a managed documentation hosting service designed for internal and private documentation. It provides secure, access-controlled hosting for your technical documentation with seamless GitHub integration.

What is Guidebook Cloud?

Guidebook Cloud hosts documentation built with Guidebook, a fast HonKit/GitBook-compatible static site generator. When you push changes to your GitHub repository, Guidebook Cloud automatically builds and deploys your documentation.

Key Features

  • Automatic Deployments - Push to GitHub and your documentation updates automatically
  • Access Control - Restrict access by IP address or specific users
  • Team Management - Organize members into teams with granular repository access
  • Branch Previews - Preview documentation from any branch before merging
  • HonKit/GitBook Compatible - Works with existing HonKit or GitBook projects

How It Works

  1. Create an Organization - Sign up and create an organization for your team
  2. Install GitHub App - Connect your GitHub account or organization
  3. Import Repositories - Select repositories containing your documentation
  4. Configure Access - Set up who can view your documentation
  5. Deploy - Push changes to automatically build and deploy

Documentation URL

Your documentation is available at:

https://guidebook.dev/{organization-slug}/{repository-slug}/

Branch-specific documentation:

https://guidebook.dev/{organization-slug}/{repository-slug}@{branch-name}/

Getting Started

Ready to get started? Head over to the Getting Started guide.