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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# Migration from HonKit

guidebook is designed as a drop-in replacement for HonKit.

## Quick Migration

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

2. Replace your commands:
   ```bash
   # Before (HonKit)
   npx honkit build
   npx honkit serve

   # After (guidebook)
   guidebook build
   guidebook serve
   ```

That's it! No configuration changes needed.

## Compatibility

### Supported

- `book.json` configuration
- `SUMMARY.md` format
- `LANGS.md` multi-language
- Markdown rendering
- Custom styles
- Most plugins (collapsible-chapters, back-to-top-button)

### Not Supported

- PDF/EPUB export (web only)
- JavaScript plugins (guidebook uses built-in Rust implementations)
- GitBook legacy format

## Benefits of Switching

| Feature | HonKit | guidebook |
|---------|--------|-----------|
| Install | Node.js + npm | Single binary |
| Build speed | Seconds | Milliseconds |
| Dependencies | Many | None |
| Self-update | Manual | `guidebook update` |

## CI/CD Migration

### Before (HonKit)

```yaml
- uses: actions/setup-node@v4
- run: npm install -g honkit
- run: honkit build
```

### After (guidebook)

```yaml
- run: |
    curl -sL https://github.com/guide-inc-org/guidebook/releases/latest/download/guidebook-linux-x86_64.tar.gz | tar xz
    ./guidebook build
```