summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-04-05 23:30:48 -0700
committerSamy Pessé <samypesse@gmail.com>2014-04-05 23:30:48 -0700
commita8e026a642b6780e01e1c94be9345a01a10018c6 (patch)
treed35578a7cb32358fa6b9997562ad7991465ff477
parentcc096d225332ad779a414bb74c00e03c08d40c09 (diff)
downloadgitbook-a8e026a642b6780e01e1c94be9345a01a10018c6.zip
gitbook-a8e026a642b6780e01e1c94be9345a01a10018c6.tar.gz
gitbook-a8e026a642b6780e01e1c94be9345a01a10018c6.tar.bz2
Add information about output format
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index eb96e49..0a90be5 100644
--- a/README.md
+++ b/README.md
@@ -33,8 +33,22 @@ Options for commands `build` and `serve` are:
-t, --title <name> Name of the book to generate, defaults to repo name
-i, --intro <intro> Description of the book to generate
-g, --github <repo_path> ID of github repo like : username/repo
+-o, --output <directory> Path to output directory, defaults to ./_book
+-f, --format <name> Change generation format, defaults to site, availables are: site, page, pdf, json
+-i, --intro <intro> Description of the book to generate
+-gh, --githubHost <url> The url of the github host (defaults to https://github.com/)
+--theme <path> Path to theme directory
```
+## Output Formats
+
+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.
+* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate to this format using: ```gitbook pdf ./myrepo```, you need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
+* **Single Page**: The book will be stored in a single printable HTML page, this format is used for conversion to PDF or eBook. Generate to this format using: ```gitbook build ./myrepo -f page```.
+* **JSON**: This format is used for debugging or extracting metadata from a book. Generate to this format using: ```gitbook build ./myrepo -f json```.
+
## Book Format
A book is a GitHub repository containing at least 2 files: `README.md` and `SUMMARY.md`.
@@ -93,3 +107,4 @@ Exercises need to start and finish with a separation bar (```---``` or ```***```
```
---
+