summaryrefslogtreecommitdiffstats
path: root/docs/ebook.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-03-09 11:10:52 +0100
committerSamy Pessé <samypesse@gmail.com>2016-03-09 11:10:52 +0100
commitbdbfbf7300ed6df752db996dfd865a695e0532fc (patch)
tree498301840990d3ec03586fe8509134a79cb1f0ca /docs/ebook.md
parentccac3d2c3cd1897047a75a01fca3c537e17434b0 (diff)
downloadgitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.zip
gitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.tar.gz
gitbook-bdbfbf7300ed6df752db996dfd865a695e0532fc.tar.bz2
Merge doc for ebook and cover
Diffstat (limited to 'docs/ebook.md')
-rw-r--r--docs/ebook.md29
1 files changed, 29 insertions, 0 deletions
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
+