diff options
| author | Samy Pessé <samypesse@gmail.com> | 2016-03-09 11:10:52 +0100 |
|---|---|---|
| committer | Samy Pessé <samypesse@gmail.com> | 2016-03-09 11:10:52 +0100 |
| commit | bdbfbf7300ed6df752db996dfd865a695e0532fc (patch) | |
| tree | 498301840990d3ec03586fe8509134a79cb1f0ca /docs | |
| parent | ccac3d2c3cd1897047a75a01fca3c537e17434b0 (diff) | |
| download | gitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.zip gitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.tar.gz gitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.tar.bz2 | |
Merge doc for ebook and cover
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SUMMARY.md | 2 | ||||
| -rw-r--r-- | docs/cover.md | 21 | ||||
| -rw-r--r-- | docs/ebook.md | 29 |
3 files changed, 30 insertions, 22 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e0e4eae..b936e84 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -24,10 +24,10 @@ * [HTML](syntax/markdown.md#html) * [Footnotes](syntax/markdown.md#footnotes) * [AsciiDoc](syntax/asciidoc.md) +* [eBook and PDF](ebook.md) ### 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 deleted file mode 100644 index 0f895fb..0000000 --- a/docs/cover.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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 - diff --git a/docs/ebook.md b/docs/ebook.md new file mode 100644 index 0000000..58a0d9b --- /dev/null +++ b/docs/ebook.md @@ -0,0 +1,29 @@ +# Generating eBooks and PDFs + +GitBook can generates a website, but can also output content as ebook (ePub, Mobi, PDF). + +### Installing ebook-convert + +`ebook-convert` is required to generate ebooks (epub, mobi, pdf). + +##### OS X + +Download the [Calibre application](https://calibre-ebook.com/download). After moving the `calibre.app` to your Applications folder create a symbolic link to the ebook-convert tool: + +``` +$ sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin +``` + +You can replace `/usr/bin` with any directory that is in your $PATH. + +### Cover + +Covers are used for all the ebook formats. It's an important part of an ebook brandline. + +A good cover should respect the following guidelines: + +* Size of 1800x2360 (pixels) +* No border +* Clearly visible book title +* Any important text should be visible in the small version + |