guidebook 0.1.75

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

# SVG Processing

guidebook provides two SVG processing modes controlled via `book.json`.

## Externalize Inline SVGs

Extract inline `<svg>` elements from HTML into separate `.svg` files:

```json
{
    "externalize_svg": true
}
```

Inline SVGs are replaced with `<img>` tags pointing to the extracted files. Icon SVGs (those with `fill="currentColor"`) are kept inline to preserve dynamic color behavior.

## Inline SVG Files

Embed external SVG files directly into the HTML:

```json
{
    "inline_svg": true
}
```

External `<img src="*.svg">` references are replaced with the SVG content inlined in the HTML. Icon SVGs remain as `<img>` tags.

## When to Use

| Option | Use Case |
|--------|----------|
| `externalize_svg` | Reduce HTML size, enable browser caching of SVGs |
| `inline_svg` | Eliminate extra HTTP requests, enable CSS styling of SVGs |