summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-05-11 16:47:30 +0200
committerSamy Pessé <samypesse@gmail.com>2014-05-11 16:47:30 +0200
commit42eb11aaffda59a77cd2fdf0ba69a1ace56129fa (patch)
tree06c699bfffe76aff529746c08d193854499e9186
parentb581859afd55a27d1b68a9550cc9a7084d6e8535 (diff)
downloadgitbook-42eb11aaffda59a77cd2fdf0ba69a1ace56129fa.zip
gitbook-42eb11aaffda59a77cd2fdf0ba69a1ace56129fa.tar.gz
gitbook-42eb11aaffda59a77cd2fdf0ba69a1ace56129fa.tar.bz2
Add infos about cover
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index ddf6999..9f7a331 100644
--- a/README.md
+++ b/README.md
@@ -187,6 +187,11 @@ You can see a complete example with the [Learn Git](https://github.com/GitbookIO
GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files, follows the same convention as `.gitignore`)
+#### Cover
+
+A cover image can be set by creating a file: **/cover.jpg** or **cover.png**.
+The best resolution is **1600x2400**. The generation of the cover can be done automatically using the plugin [autocover](https://github.com/GitbookIO/plugin-autocover).
+
#### Plugins
Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for gitbook.
@@ -200,6 +205,7 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
* [Google Analytics](https://github.com/GitbookIO/plugin-ga): Google Analytics tracking for your book
* [Disqus](https://github.com/GitbookIO/plugin-disqus): Disqus comments integration in your book
+* [Autocover](https://github.com/GitbookIO/plugin-autocover): Generate a cover for yoru book
* [Transform annoted quotes to notes](https://github.com/erixtekila/gitbook-plugin-richquotes): Allow extra markdown markup to render blockquotes as nice notes
* [Send code to console](https://github.com/erixtekila/gitbook-plugin-toconsole): Evaluate javascript blockin the browser inspector's console
* [Revealable sections](https://github.com/mrpotes/gitbook-plugin-reveal): Reveal sections of the page using buttons made from the first title in each section