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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

# Configuration

Configuration is optional. guidebook works out of the box without any configuration.

## book.json

Create a `book.json` file in your book's root directory:

```json
{
    "title": "My Book",
    "plugins": [
        "collapsible-chapters",
        "back-to-top-button",
        "mermaid-md-adoc"
    ],
    "styles": {
        "website": "styles/website.css"
    }
}
```

## Options

| Option | Description | Default |
|--------|-------------|---------|
| `title` | Book title | `"My Book"` |
| `plugins` | Enabled plugins | See below |
| `styles.website` | Custom CSS file | `null` |
| `variables` | User-defined variables for `{{ book.xxx }}` | `{}` |
| `hardbreaks` | Treat single newlines as `<br>` | `false` |
| `math` | Enable KaTeX math rendering | `false` |
| `externalize_svg` | Externalize inline SVGs to separate files | `false` |
| `inline_svg` | Inline SVG files into HTML | `false` |
| `fetchRemoteImages` | Download remote images at build time | `false` |
| `openapi` | OpenAPI/Swagger UI specification file | `null` |

## Default Plugins

These plugins are enabled by default (no configuration needed):

- `collapsible-chapters` - Collapsible sidebar navigation
- `back-to-top-button` - Back to top button
- `mermaid-md-adoc` - Mermaid diagram support
- `fontsettings` - Font size and theme controls (white/sepia/night)

To disable a default plugin, prefix it with `-`:

```json
{
    "plugins": ["-mermaid-md-adoc"]
}
```

## Variables

Define custom variables and use them in your Markdown files with Nunjucks/Jinja2 syntax:

```json
{
    "variables": {
        "version": "1.0.0",
        "appName": "My App"
    }
}
```

In your Markdown:

```markdown
Current version: {{ book.version }}

Welcome to {{ book.appName }}!
```

Variables inside code blocks (`` ` `` and ` ``` `) are not expanded.

## Math (KaTeX)

Enable math rendering:

```json
{
    "math": true
}
```

Use `$...$` for inline math and `$$...$$` for display math.

## Remote Image Downloading

Download remote HTTPS images at build time for offline access:

```json
{
    "fetchRemoteImages": true
}
```

Images are cached in `_remote_images/` with CRC32-based filenames. Maximum download size is 50 MB per image.

## OpenAPI / Swagger UI

Generate Swagger UI from an OpenAPI spec:

```json
{
    "openapi": "swagger.json"
}
```

For multiple APIs:

```json
{
    "openapi": {
        "api-docs": "swagger/v1.json",
        "admin-api": "swagger/admin.json"
    }
}
```

## Custom Styles

Create a CSS file and reference it in `book.json`:

```css
/* styles/website.css */
.book {
    font-family: "Noto Sans", sans-serif;
}

.markdown-section h2 {
    border-left: 4px solid #007acc;
    padding-left: 10px;
}
```