diff options
author | Samy Pessé <samypesse@gmail.com> | 2014-06-02 11:41:16 +0200 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2014-06-02 11:41:16 +0200 |
commit | c0ae0138f8f22f5dcf45c56b8ef83660d44ecc95 (patch) | |
tree | 269c6dc6936d6df01ac8ad6a15d12c9343a2ff40 /README.md | |
parent | b1b9dc5b0a52ab1a7355a6d5f83e7187b028c217 (diff) | |
download | gitbook-c0ae0138f8f22f5dcf45c56b8ef83660d44ecc95.zip gitbook-c0ae0138f8f22f5dcf45c56b8ef83660d44ecc95.tar.gz gitbook-c0ae0138f8f22f5dcf45c56b8ef83660d44ecc95.tar.bz2 |
Improve documentation about book.json
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 13 insertions, 3 deletions
@@ -39,18 +39,28 @@ GitBook loads the default configuration from a `book.json` file in the repositor Here are the options that can be stored in this file: -``` +```js { - // Folders to use for output (caution: it overrides the value from the command line) + // Folders to use for output + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json "output": null, - // Generator to use for building (caution: it overrides the value from the command line) + // Generator to use for building + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json "generator": "site", // Book title and description (defaults are extracted from the README) "title": null, "description": null, + // For ebook format, the extension to use for generation (default is detected from output extension) + // "epub", "pdf", "mobi" + // Caution: it overrides the value from the command line + // It's not advised this option in the book.json + "extension": null, + // GitHub information (defaults are extracted using git) "github": null, "githubHost": "https://github.com/", |