guidebook 0.1.31

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

# 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",
    "description": "A description of my book",
    "author": "Your Name",
    "plugins": [
        "collapsible-chapters",
        "back-to-top-button",
        "mermaid-md-adoc"
    ],
    "styles": {
        "website": "styles/website.css"
    }
}
```

## Options

| Option | Description | Default |
|--------|-------------|---------|
| `title` | Book title | `"My Book"` |
| `description` | Book description | `""` |
| `author` | Author name | `""` |
| `plugins` | Enabled plugins | See below |
| `styles.website` | Custom CSS 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

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

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

## 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;
}
```