diff options
| author | Soreine <soreine.plume@gmail.com> | 2016-03-05 20:08:25 +0100 |
|---|---|---|
| committer | Soreine <soreine.plume@gmail.com> | 2016-03-06 09:08:48 +0100 |
| commit | 6a732177405b8b8abdeb14ac71e1b2af5366ee0c (patch) | |
| tree | 61160b7310b556d33e74cba1f92cbbbddf965108 /docs | |
| parent | 47c44fca89b97fb1075e2d49a711478dc8f32a3e (diff) | |
| download | gitbook-6a732177405b8b8abdeb14ac71e1b2af5366ee0c.zip gitbook-6a732177405b8b8abdeb14ac71e1b2af5366ee0c.tar.gz gitbook-6a732177405b8b8abdeb14ac71e1b2af5366ee0c.tar.bz2 | |
Adds section for covers
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/cover.md | 26 | ||||
| -rw-r--r-- | docs/examples.md | 2 |
3 files changed, 28 insertions, 1 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 5541b58..953d436 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -16,6 +16,7 @@ ### Customization +* [Cover](cover.md) * [Templating](templating/README.md) * [Content References](templating/conrefs.md) * [Variables](templating/variables.md) diff --git a/docs/cover.md b/docs/cover.md new file mode 100644 index 0000000..b7e8672 --- /dev/null +++ b/docs/cover.md @@ -0,0 +1,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). diff --git a/docs/examples.md b/docs/examples.md index fc1cfe6..a748c33 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -4,7 +4,7 @@ description: Real world examples of content published using GitBook. # Examples -More than 50,000 books have benn published on [GitBook.com](https://www.gitbook.com/explore). +More than 50,000 books have been published on [GitBook.com](https://www.gitbook.com/explore). ### Books |