diff options
author | Samy Pessé <samypesse@gmail.com> | 2015-01-19 10:08:49 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2015-01-19 10:08:49 +0100 |
commit | d9c020194d949bd7591c51f6a6bfb48612f39a09 (patch) | |
tree | d9715f3fda2751481a89a2afcfa9ada2a1d8ccb7 /lib/configuration.js | |
parent | ec586dd3cdf06e9567f5d3e4961022ddc3c94778 (diff) | |
download | gitbook-d9c020194d949bd7591c51f6a6bfb48612f39a09.zip gitbook-d9c020194d949bd7591c51f6a6bfb48612f39a09.tar.gz gitbook-d9c020194d949bd7591c51f6a6bfb48612f39a09.tar.bz2 |
Add base object to load configuration
Diffstat (limited to 'lib/configuration.js')
-rw-r--r-- | lib/configuration.js | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/lib/configuration.js b/lib/configuration.js new file mode 100644 index 0000000..c5c1ba2 --- /dev/null +++ b/lib/configuration.js @@ -0,0 +1,114 @@ +var _ = require("lodash"); +var Q = require("q"); +var path = require("path"); + +var fs = require("./utils/fs"); + +var Configuration = function(book, options) { + this.book = book; + this.options = _.defaults(options || {}, Configuration.DEFAULT); +}; + +// Read and parse the configuration +Configuration.prototype.load = function() { + var that = this; + + return Q() + .then(function() { + try { + var _config = require(path.resolve(that.book.root, "book")); + that.options = _.merge( + that.options, + _.omit(_config, 'input', 'configFile', 'defaultsPlugins', 'generator') + ); + } + catch(err) { + return Q(); + } + }); +}; + +// Default configuration +Configuration.DEFAULT = { + // Book metadats (somes are extracted from the README by default) + "title": null, + "description": null, + "isbn": 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, + + // Plugins list, can contain "-name" for removing default plugins + "plugins": [], + + // Global configuration for plugins + "pluginsConfig": { + "fontSettings": { + "theme": null, //"sepia", "night" or "white", + "family": "sans",// "serif" or "sans", + "size": 2 // 1 - 4 + } + }, + + // Variables for templating + "variables": {}, + + // Set another theme with your own layout + // It's recommended to use plugins or add more options for default theme, though + // See https://github.com/GitbookIO/gitbook/issues/209 + "theme": path.resolve(__dirname, '../../theme'), + + // Links in template (null: default, false: remove, string: new value) + "links": { + // Custom links at top of sidebar + "sidebar": { + //"Custom link name": "https://customlink.com" + }, + + // Sharing links + "sharing": { + "google": null, + "facebook": null, + "twitter": null, + "weibo": null, + "all": null + } + }, + + + // Options for PDF generation + "pdf": { + // Add toc at the end of the file + "toc": true, + + // Add page numbers to the bottom of every page + "pageNumbers": false, + + // Font size for the file content + "fontSize": 12, + + // Paper size for the pdf + // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’] + "paperSize": "a4", + + // Margin (in pts) + // Note: 72 pts equals 1 inch + "margin": { + "right": 62, + "left": 62, + "top": 36, + "bottom": 36 + }, + + //Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_. + "headerTemplate": "", + + //Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_. + "footerTemplate": "" + } +}; + +module.exports= Configuration; |