diff options
author | Samy Pessé <samypesse@gmail.com> | 2014-05-20 14:40:22 +0200 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2014-05-20 14:40:22 +0200 |
commit | ca37ac73a9900640d51eeaab825ffc413ac4ec67 (patch) | |
tree | 6dbc8ed67caaa67738da82251eacdf9f66e5e11a | |
parent | 96edd50c8f44aea7b4aea9ab263bfc9bd7d113b9 (diff) | |
download | gitbook-ca37ac73a9900640d51eeaab825ffc413ac4ec67.zip gitbook-ca37ac73a9900640d51eeaab825ffc413ac4ec67.tar.gz gitbook-ca37ac73a9900640d51eeaab825ffc413ac4ec67.tar.bz2 |
Add more infos about gitbook.io
-rw-r--r-- | README.md | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -3,7 +3,7 @@ GitBook [](https://travis-ci.org/GitbookIO/gitbook) -GitBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](http://gitbookio.github.io/javascript/). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. +GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter.  @@ -106,7 +106,7 @@ GitBook can generate your book in the following formats: ## Book Format -A book is a GitHub repository containing at least 2 files: `README.md` and `SUMMARY.md`. +A book is a Git repository containing at least 2 files: `README.md` and `SUMMARY.md`. #### README.md @@ -194,6 +194,10 @@ The best resolution is **1800x2360**. The generation of the cover can be done au A small version of the cover can also be set by creating a file: **/cover_small.jpg**. +#### Publish your book + +The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books", you can create a book on it (public, paid, or private) and update it using **git push**. + #### 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. |