Introduction

guidebook is a fast, HonKit/GitBook-compatible static site generator written in Rust.

Why guidebook?

• Fast - Built with Rust for maximum performance
• Simple - One binary, no dependencies
• Compatible - Drop-in replacement for HonKit/GitBook
• Self-updating - Update with guidebook update

Quick Example

# Install
curl -fsSL https://raw.githubusercontent.com/guide-inc-org/guidebook/main/install.sh | sh

# Initialize a new book
guidebook init my-book
cd my-book

# Preview your book
guidebook serve

# Build for production
guidebook build

Getting Started

Ready to start? Head over to the Installation guide.

Cloud Hosting

Deploy your documentation with Guidebook Cloud for automatic deployments on push.