From 4f29183685de987a8e5236a42334729dfb3bef8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Thu, 25 Feb 2016 12:10:58 +0100 Subject: [PATCH] Document pdf options --- docs/config.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/config.md b/docs/config.md index a7484df58..060a9d0fe 100644 --- a/docs/config.md +++ b/docs/config.md @@ -16,6 +16,20 @@ GitBook allows you to customize your book using a flexible configuration. These | `plugins` | List of plugins to load, See [the plugins section](plugins.md) for more details | | `pluginsConfig` |Configuration for plugins, See [the plugins section](plugins.md) for more details | +### PDF Options + +PDF Output can be customized using a set of options in the `book.json`: + +| Variable | Description | +| -------- | ----------- | +| `pdf.pageNumbers` | Add page numbers to the bottom of every page (default is `true`) | +| `pdf.fontSize` | Base font size (default is `12`) | +| `pdf.fontFamily` | Base font family (default is `Arial`) | +| `pdf.paperSize` | Paper size, options are `'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter'` (default is `a4`) | +| `pdf.margin.top` | Top margin (default is `56`) | +| `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