gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-10-03 20:20:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation about book.json

Browse Source
This commit is contained in:
Samy Pessé
2014-06-02 11:41:16 +02:00
parent b1b9dc5b0a
commit c0ae0138f8
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -3
View File
@@ -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/",