diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -16,6 +16,11 @@ GitBook can be installed from **NPM** using: $ npm install gitbook -g ``` +Create the directories and files for a book from its [SUMMARY.md](https://github.com/GitbookIO/gitbook#book-format) file using +``` +$ gitbook init +``` + You can serve a repository as a book using: ``` @@ -52,9 +57,10 @@ Here are the options that can be stored in this file: // It's not advised this option in the book.json "generator": "site", - // Book title and description (defaults are extracted from the README) + // Book metadats (somes are extracted from the README by default) "title": null, "description": null, + "isbn": null, // For ebook format, the extension to use for generation (default is detected from output extension) // "epub", "pdf", "mobi" @@ -132,7 +138,10 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb GitBook can generate your book in the following formats: * **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages. -* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed. The output format could be **PDF**, **ePub** or **MOBI**. +* **eBook**: A complete eBook with exercise solutions at the end of the book. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed. You can specify the eBook filename with the `-o` option, otherwise `book` will be used. + * Generate a **PDF** using: `gitbook pdf ./myrepo` + * Generate a **ePub** using: `gitbook epub ./myrepo` + * Generate a **MOBI** using: `gitbook mobi ./myrepo` * **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```. ## Book Format @@ -211,6 +220,8 @@ The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books" Plugins can be 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. +Plugins needed to build a book can be installed using: `gitbook install ./`. + ##### Official plugins: | Name | Description | |