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

# Cấu trúc dự án

## Cấu trúc cơ bản

```
my-book/
├── book.json       # Cấu hình (tùy chọn)
├── README.md       # Giới thiệu
├── SUMMARY.md      # Mục lục
├── chapter1.md
├── chapter2/
│   ├── README.md   # Giới thiệu chương 2
│   ├── section1.md
│   └── section2.md
├── assets/
│   └── images/
└── styles/
    └── website.css # CSS tùy chỉnh
```

## File bắt buộc

### SUMMARY.md

Định nghĩa mục lục và cấu trúc navigation:

```markdown
# Mục lục

* [Giới thiệu](README.md)
* [Bắt đầu](getting-started.md)
* [Chủ đề nâng cao](advanced/README.md)
  * [Chủ đề 1](advanced/topic1.md)
  * [Chủ đề 2](advanced/topic2.md)
```

### README.md

Trang giới thiệu, trở thành `index.html`.

## File tùy chọn

### book.json

File cấu hình. Xem [Cấu hình](config.md).

### GLOSSARY.md

Định nghĩa thuật ngữ được tự động liên kết trong toàn bộ sách:

```markdown
## API
Application Programming Interface

## HTML
HyperText Markup Language
```

Thuật ngữ hiển thị tooltip khi hover. Xem [Bảng thuật ngữ](features/glossary.md).

### LANGS.md

Cho sách đa ngôn ngữ:

```markdown
# Languages

* [English](en/)
* [日本語](ja/)
* [Tiếng Việt](vi/)
```

## Assets

Đặt hình ảnh và assets khác trong thư mục `assets/`:

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

Đường dẫn tương đối cũng được hỗ trợ:

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