guidebook 0.1.29

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

# Project Structure

## Basic Structure

```
my-book/
├── book.json       # Configuration (optional)
├── README.md       # Introduction
├── SUMMARY.md      # Table of contents
├── chapter1.md
├── chapter2/
│   ├── README.md   # Chapter 2 intro
│   ├── section1.md
│   └── section2.md
├── assets/
│   └── images/
└── styles/
    └── website.css # Custom styles
```

## Required Files

### SUMMARY.md

Defines the table of contents and navigation structure:

```markdown
# Summary

* [Introduction](README.md)
* [Getting Started](getting-started.md)
* [Advanced Topics](advanced/README.md)
  * [Topic 1](advanced/topic1.md)
  * [Topic 2](advanced/topic2.md)
```

### README.md

The introduction page, becomes `index.html`.

## Optional Files

### book.json

Configuration file. See [Configuration](config.md).

### LANGS.md

For multi-language books:

```markdown
# Languages

* [English](en/)
* [日本語](ja/)
```

## Assets

Place images and other assets in an `assets/` folder:

```
![My Image](assets/images/screenshot.png)
```

Relative paths are also supported:

```
![My Image](../assets/images/screenshot.png)
```