guidebook 0.1.73

HonKit/GitBook compatible static book generator
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# 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

```bash
# 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](installation.md) guide.

## Cloud Hosting

Deploy your documentation with [Guidebook Cloud](https://guidebook.dev) for automatic deployments on push.