summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJuho Vepsalainen <bebraw@gmail.com>2014-06-03 15:55:24 +0300
committerJuho Vepsalainen <bebraw@gmail.com>2014-06-03 17:42:30 +0300
commitb6d11d88b78149ee0d235b4f7373caf21115c863 (patch)
tree242b2786cdca2a0d592d1e0bdfab34054ac01bcb /README.md
parentc803270af8c2f7d19de83f2997dbd7fe7675bd54 (diff)
downloadgitbook-b6d11d88b78149ee0d235b4f7373caf21115c863.zip
gitbook-b6d11d88b78149ee0d235b4f7373caf21115c863.tar.gz
gitbook-b6d11d88b78149ee0d235b4f7373caf21115c863.tar.bz2
Allow book.js to be used in addition to book.json
Now it's possible to comment configuration properly and do some dynamic things if needed. Closes #287.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 03fa1c5..9cede83 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Options for commands `build` and `serve` are:
```
-o, --output <directory> Path to output directory, defaults to ./_book
-f, --format <name> Change generation format, defaults to site, availables are: site, page, ebook, json
---config <config file> Configuration file to use, defaults to book.json
+--config <config file> Configuration file to use, defaults to book.js or book.json
```
GitBook loads the default configuration from a `book.json` file in the repository if it exists.