summaryrefslogtreecommitdiffstats
path: root/docs/cover.md
blob: b7e86722d3003839c26eed164c71dcd6b5cd14d1 (plain)
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
# Cover

Covers are used for all the ebook formats, and to make books more elegant on GitBook.com.

To provide a cover, place a **cover.jpg** file at the root directory of your book. Adding a **cover_small.jpg** will specify a smaller version of the cover. The cover should be a **JPEG** file.

### Best Sizes

|                     |     Big     |       Small       |
|:-------------------:|:-----------:|:-----------------:|
|       **File**      | `cover.jpg` | `cover_small.jpg` |
| **Size(in pixels)** |  1800x2360  |      200x262      |

### Guidelines

A good cover respects the following guidelines:

* No border
* Clearly visible book title
* Any important text should be visible in the small version

### Autocover

A GitBook plugin (`autocover`) can also be used to automatically generate a cover file, or just create a `cover_small.jpg` from a `cover.jpg`. This plugin is added by default on hosted books.

[Read more about autocover](https://github.com/GitbookIO/plugin-autocover).