guidebook 0.1.32

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

# 設定

設定はオプションです。guidebook は設定なしでも動作します。

## book.json

ブックのルートディレクトリに `book.json` ファイルを作成：

```json
{
    "title": "私のブック",
    "description": "ブックの説明",
    "author": "著者名",
    "plugins": [
        "collapsible-chapters",
        "back-to-top-button",
        "mermaid-md-adoc"
    ],
    "styles": {
        "website": "styles/website.css"
    }
}
```

## オプション

| オプション | 説明 | デフォルト |
|-----------|------|----------|
| `title` | ブックタイトル | `"My Book"` |
| `description` | ブックの説明 | `""` |
| `author` | 著者名 | `""` |
| `plugins` | 有効なプラグイン | 下記参照 |
| `styles.website` | カスタム CSS ファイル | `null` |

## デフォルトプラグイン

以下のプラグインはデフォルトで有効（設定不要）：

- `collapsible-chapters` - 折りたたみサイドバー
- `back-to-top-button` - トップに戻るボタン
- `mermaid-md-adoc` - Mermaid 図のサポート

デフォルトプラグインを無効にするには、`-` をプレフィックスに：

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

## カスタムスタイル

CSS ファイルを作成し、`book.json` で参照：

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

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