diff options
Diffstat (limited to 'docs/config.md')
| -rw-r--r-- | docs/config.md | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/docs/config.md b/docs/config.md index de3816b..fc9b411 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,21 +1,28 @@ # Configuration -GitBook allows you to customize your book using a flexible configuration. These options are specified in a `book.json` file. For authors, not used to write JSON, you can validate the syntax using [jsonlint](http://jsonlint.com). +GitBook allows you to customize your book using a flexible configuration. These options are specified in a `book.json` file. For authors unfamiliar with the JSON syntax, you can validate the syntax using tools such as [JSONlint](http://jsonlint.com). -### Configuration Settings +### General Settings | Variable | Description | | -------- | ----------- | -| `root` | Path to the root folder containing the content | +| `root` | Path to the root folder containing all the book's files, except `book.json`| | `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. | | `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. | | `author` | Name of the author. On GitBook.com this field is pre-filled. | | `isbn` | ISBN of the book | -| `language` | ISO code of the book's language, default value is `en` | -| `direction` | `rtl` or `ltr`, default value depends on the value of `language` | -| `gitbook` | [SemVer](http://semver.org) condition to validate which GitBook version should be used | -| `plugins` | List of plugins to load, See [the plugins section](plugins/README.md) for more details | -| `pluginsConfig` |Configuration for plugins, See [the plugins section](plugins/README.md) for more details | +| `language` | [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the book's language, default value is `en` | +| `direction` | Text's direction. Can be `rtl` or `ltr`, the default value depends on the value of `language` | +| `gitbook` | Version of GitBook that should be used. Uses the [SemVer](http://semver.org) specification and accepts conditions like `">= 3.0.0"` | + +### Plugins + +Plugins and their configurations are specified in the `book.json`. See [the plugins section](plugins/README.md) for more details. + +| Variable | Description | +| -------- | ----------- | +| `plugins` | List of plugins to load | +| `pluginsConfig` |Configuration for plugins | ### PDF Options @@ -31,8 +38,3 @@ PDF Output can be customized using a set of options in the `book.json`: | `pdf.margin.bottom` | Bottom margin (default is `56`) | | `pdf.margin.right` | Right margin (default is `62`) | | `pdf.margin.left` | Left margin (default is `62`) | - -### Plugins - -Plugins and their configurations are specified in the `book.json`. See [the plugins section](plugins/README.md) for more details. - |