Configuration

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.

General Settings

Ejemplo de structure (del libro Front-End Developer Handbook 2016:

{
    "structure": {
        "readme": "myIntro.md"
    },
    "plugins": ["scripts"],
    "pluginsConfig": {
        "scripts": {
            "files": [
                "./gtm-analytics.js"
            ]
        }
    }
}

Otro ejemplo del libro Presentaciones de SYTW alojado en https://ull-esit-sytw-1617.github.io/presentaciones-todos/:

{
  "language": "es",
  "author": "ULL-ESIT-SYTW-1617",
  "license": "MIT",
  "repo": "https://github.com/ULL-ESIT-SYTW-1617/presentaciones-todos",
  "ghPages": "http://ULL-ESIT-SYTW-1617.github.io/presentaciones-todos",
  "name": "presentaciones",
  "title" : "presentaciones" ,
  "description" : "Libro de las presentaciones de SYTW del curso 2016/17",
  "plugins": [
    "advanced-emoji",
    "collapsible-menu",
    "js-console",
    "youtube",
    "codetabs",
    "es6tabs-stage-0"
  ],
  "pluginsConfig": {
    "es6tabs": {
      "presets": ["es2015", "stage-0"]
    }
  },
  "root": "./txt"
}

Plugins

Plugins and their configurations are specified in the book.json. See the plugins section for more details.

Since version 3.0.0, GitBook can use themes. See the theming section for more details.

Structure

In addition to the root variable, you can tell Gitbook the name of the files for Readme, Summary, Glossary, Languages (instead of using the default names such as README.md). These files must be at the root of your book (or the root of every language book). Paths such as dir/MY_README.md are not accepted.

PDF Options

PDF Output can be customized using a set of options in the book.json: