Bump version to 0.5.0

Set sans-serif as default

Gruntfile.js

@@ -24,8 +24,8 @@ module.exports = function (grunt) {
                     optimization: 2
                 },
                 files: {
-                    "theme/assets/style.css": "theme/stylesheets/main.less",
-                    "theme/assets/print.css": "theme/stylesheets/print.less"
+                    "theme/assets/style.css": "theme/stylesheets/website.less",
+                    "theme/assets/print.css": "theme/stylesheets/ebook.less"
                 }
             }
         },

README.md

@@ -31,26 +31,36 @@ Options for commands `build` and `serve` are:
 
 ```
 -o, --output <directory>  Path to output directory, defaults to ./_book
--f, --format <name>       Change generation format, defaults to site, availables are: site, page, pdf, json, mobi, epub
---config <config file>    Configuration file to use, defaults to book.json
+-f, --format <name>       Change generation format, defaults to site, availables are: site, page, ebook, json
+--config <config file>    Configuration file to use, defaults to book.js or book.json
 ```
 
 GitBook loads the default configuration from a `book.json` file in the repository if it exists.
 
 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/",
@@ -88,6 +98,32 @@ Here are the options that can be stored in this file:
             "facebook": null,
             "twitter": 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 fiel 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
+        }
     }
 }
 ```

bin/build.js

@@ -12,7 +12,7 @@ var buildCommand = function(command) {
     return command
     .option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
     .option('-f, --format <name>', 'Change generation format, defaults to site, availables are: '+_.keys(generators).join(", "))
-    .option('--config <config file>', 'Configuration file to use, defualt to book.json')
+    .option('--config <config file>', 'Configuration file to use, defaults to book.js or book.json')
 };
 
 
@@ -36,7 +36,7 @@ var makeBuildFunc = function(converter) {
             })
         )
         .then(function(output) {
-            console.log("Successfuly built !");
+            console.log("Successfully built!");
             return output;
         }, utils.logError)
         .fail(function() {

bin/gitbook.js

@@ -80,17 +80,6 @@ build.command(prog.command('serve [source_dir]'))
     generate();
 });
 
-build.commandEbook(prog.command('ebook [source_dir]'))
-.description('Build a gitbook as a eBook (format detected according to the extension)')
-.action(function(dir, options) {
-    var ext = options.output ? path.extname(options.output) : "epub";
-
-    build.file(dir, _.extend(options, {
-        extension: ext,
-        format: "ebook"
-    }));
-});
-
 build.commandEbook(prog.command('pdf [source_dir]'))
 .description('Build a gitbook as a PDF')
 .action(function(dir, options) {

lib/generate/ebook/index.js

@@ -15,11 +15,6 @@ var stringUtils = require("../../utils/string");
  */
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
-
-    // Options for eBook generation
-    this.options = _.defaults(this.options, {
-        extension: "epub"
-    });
 };
 util.inherits(Generator, BaseGenerator);
 
@@ -29,7 +24,7 @@ Generator.prototype.finish = function() {
     return BaseGenerator.prototype.finish.apply(this)
     .then(function() {
         var d = Q.defer();
-        var format = that.options.extension || path.extname(that.options.output);
+        var format = that.options.extension || path.extname(that.options.output).replace("\.", "") || "pdf";
 
         if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
             that.options.cover = path.join(that.options.output, "cover.jpg");
@@ -46,21 +41,35 @@ Generator.prototype.finish = function() {
         };
 
         if (format == "pdf") {
+            var pdfOptions = _.defaults(that.options.pdf || {}, {
+                "fontSize": 12,
+                "toc": true,
+                "pageNumbers": false,
+                "paperSize": "a4",
+                "margin": {
+                    "right": 62,
+                    "left": 62,
+                    "top": 36,
+                    "bottom": 36
+                }
+            });
+
             _.extend(_options, {
-                "--margin-left": "62",
-                "--margin-right": "62",
-                "--margin-top": "36",
-                "--margin-bottom": "36",
-                "--pdf-add-toc": true,
-                "--pdf-default-font-size": "12",
-                "--paper-size": "a4",
+                "--margin-left": String(pdfOptions.margin.left),
+                "--margin-right": String(pdfOptions.margin.right),
+                "--margin-top": String(pdfOptions.margin.top),
+                "--margin-bottom": String(pdfOptions.margin.bottom),
+                "--pdf-add-toc": Boolean(pdfOptions.toc),
+                "--pdf-default-font-size": String(pdfOptions.fontSize),
+                "--paper-size": String(pdfOptions.paperSize),
+                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers)
             });
         }
 
         var command = [
             "ebook-convert",
             path.join(that.options.output, "index.html"),
-            path.join(that.options.output, "index."+that.options.extension),
+            path.join(that.options.output, "index."+format),
             stringUtils.optionsToShellArgs(_options)
         ].join(" ");
 

lib/generate/index.js

@@ -25,13 +25,23 @@ var containsFiles = function(dir, files) {
     .then(_.all);
 };
 
+// TEst if generator exists
+var checkGenerator = function(options) {
+    if (!generators[options.generator]) {
+        return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")+")"));
+    }
+    return Q();
+};
 
 // Create the generator and load plugins
 var loadGenerator = function(options) {
-    var generator = new generators[options.generator](options);
+    return checkGenerator(options)
+    .then(function() {
+        var generator = new generators[options.generator](options);
 
-    return generator.loadPlugins()
-    .then(_.constant(generator));
+        return generator.loadPlugins()
+        .then(_.constant(generator));
+    });
 };
 
 
@@ -44,7 +54,7 @@ var generate = function(options) {
         "output": null,
 
         // Config file (relative to input)
-        "configFile": "book.json",
+        "configFile": "book",
 
         // Output generator
         "generator": "site",
@@ -78,27 +88,20 @@ var generate = function(options) {
         return Q.reject(new Error("Need option input (book input directory)"));
     }
 
-    // Ensure generator exists
-    if (!generators[options.generator]) {
-        return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")));
-    }
-
     // Check files to get folder type (book, multilanguage book or neither)
-    return Q()
+    return checkGenerator(options)
 
     // Read config file
     .then(function() {
-        return fs.readFile(path.resolve(options.input, options.configFile))
-        .then(function(_config) {
-            // Extend current config
-            _config = JSON.parse(_config);
-            _config = _.omit(_config, 'input', 'configFile', 'defaultsPlugins');
+        try {
+            var _config = require(path.resolve(options.input, options.configFile));
 
-            _.extend(options, _config);
-        }, function() {
+            _.extend(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins'));
+        }
+        catch(err) {
             // No config file: not a big deal
             return Q();
-        });
+        }
     })
 
     // Read readme
@@ -133,8 +136,12 @@ var generateMultiLang = function(options) {
     var langsSummary;
     options.output = options.output || path.join(options.input, "_book");
 
+    return checkGenerator(options)
+
     // Multi-languages book
-    return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
+    .then(function() {
+        return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
+    })
 
     // Clean output folder
     .then(function(_langsSummary) {

lib/generate/page/index.js

@@ -23,6 +23,11 @@ swig.setFilter('lvl', function(lvl) {
     return lvl.split(".").length;
 });
 
+// Join path
+swig.setFilter('pathJoin', function(base, _path) {
+    return path.join(base, _path);
+});
+
 
 /*
  *  This generator will generate a simple index.html which can be converted as a PDF
@@ -66,6 +71,11 @@ Generator.prototype.convertFile = function(content, input) {
     });
 };
 
+// Generate languages index
+Generator.prototype.langsIndex = function(langs) {
+    return Q();
+};
+
 Generator.prototype.finish = function() {
     var that = this;
     var basePath = ".";

lib/generate/plugin.js

@@ -163,6 +163,7 @@ Plugin.fromList = function(names, root) {
     resources.html = {}
 
     _.each(plugins, function(plugin) {
+        if (!plugin.infos.book || !plugin.infos.book.html) return;
         var html = plugin.infos.book.html || {};
         _.each(html, function(code, key) {
             if (!_.isFunction(code)) code = _.constant(code);
@@ -200,7 +201,6 @@ Plugin.fromList = function(names, root) {
 
 // Default plugins
 Plugin.defaults = [
-    "mixpanel",
     "mathjax"
 ];
 

lib/utils/string.js

@@ -11,7 +11,7 @@ function escapeShellArg(arg) {
 function optionsToShellArgs(options) {
     return _.chain(options)
     .map(function(value, key) {
-        if (value == null) return null;
+        if (value == null || value == false) return null;
         if (value == true) return key;
         return key+"="+escapeShellArg(value);
     })

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.4.8",
+    "version": "0.5.0",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -22,7 +22,6 @@
         "resolve": "0.6.3",
         "tiny-lr-fork": "0.0.5",
         "gitbook-plugin": "0.0.2",
-        "gitbook-plugin-mixpanel": "0.0.2",
         "gitbook-plugin-mathjax": "0.0.3",
         "gitbook-plugin-livereload": "0.0.1"
     },

theme/javascript/core/font-settings.js

@@ -92,7 +92,7 @@ define([
         // Instantiate font state object
         fontState = storage.get("fontState", {
             size: config.size || 1,
-            family: FAMILY[config.family || "serif"],
+            family: FAMILY[config.family || "sans"],
             theme: THEMES[config.theme || "white"]
         });
         fontState.save = function(){

theme/stylesheets/ebook.less

@@ -1,12 +1,8 @@
 @import "vendors/bootstrap/bootstrap.less";
-
 @import "mixins.less";
-/*@import "variables.less";*/
 
-@import "page/highlight.less";
-
-
-@font-size-base:          13px;
+@import "ebook/variables.less";
+@import "ebook/highlight.less";
 
 .book-chapter {
     display: none;
@@ -31,6 +27,7 @@ pre, blockquote {
 img {
     max-width: 100% !important;
     page-break-inside: avoid;
+    margin: 0px auto;
 }
 
 .exercise {

theme/stylesheets/ebook/variables.less

@@ -0,0 +1 @@
+@font-size-base:          13px;

theme/stylesheets/mixins.less

@@ -4,4 +4,4 @@
     &:hover, &:focus {
         color: inherit;
     }
-}
+}

theme/stylesheets/website.less

@@ -2,19 +2,19 @@
 @import "vendors/fontawesome/font-awesome.less";
 
 @import "mixins.less";
-@import "variables.less";
-@import "fonts.less";
 
-@import "book/languages.less";
-@import "book/header.less";
-@import "book/summary.less";
-@import "book/font-settings.less";
-@import "book/body.less";
-@import "book/exercise.less";
-@import "book/quiz.less";
-@import "book/markdown.less";
-@import "book/progress.less";
-@import "book/navigation.less";
+@import "website/fonts.less";
+@import "website/variables.less";
+@import "website/languages.less";
+@import "website/header.less";
+@import "website/summary.less";
+@import "website/font-settings.less";
+@import "website/body.less";
+@import "website/exercise.less";
+@import "website/quiz.less";
+@import "website/markdown.less";
+@import "website/progress.less";
+@import "website/navigation.less";
 
 * {
     -webkit-overflow-scrolling: touch;

theme/stylesheets/website/fonts.less

@@ -1,15 +1,3 @@
-@font-face {
-    font-family: 'EB Garamond';
-    font-style: normal;
-    font-weight: 400;
-    src: local('EB Garamond 12 Regular'),url('@{FontPath}/ebgaramond/400.woff') format('woff');
-}
-@font-face {
-    font-family: 'EB Garamond';
-    font-style: italic;
-    font-weight: 400i;
-    src: local('EB Garamond 12 Italic'),url('@{FontPath}/ebgaramond/400i.woff') format('woff');
-}
 @font-face {
     font-family: 'Merriweather';
     font-style: normal;
@@ -19,7 +7,7 @@
 @font-face {
     font-family: 'Merriweather';
     font-style: italic;
-    font-weight: 250i;
+    font-weight: 250;
     src: local('Merriweather Light Italic'),url('@{FontPath}/merriweather/250i.woff') format('woff');
 }
 @font-face {
@@ -31,21 +19,9 @@
 @font-face {
     font-family: 'Merriweather';
     font-style: italic;
-    font-weight: 400i;
+    font-weight: 400;
     src: local('Merriweather Italic'),url('@{FontPath}/merriweather/400i.woff') format('woff');
 }
-@font-face {
-    font-family: 'Merriweather';
-    font-style: normal;
-    font-weight: 600;
-    src: local(''),url('@{FontPath}/merriweather/600.woff') format('woff');
-}
-/*@font-face {
-    font-family: 'Merriweather';
-    font-style: italic;
-    font-weight: 600i;
-    src: local(''),url('@{FontPath}/merriweather/600i.woff') format('woff');
-}*/
 @font-face {
     font-family: 'Merriweather';
     font-style: normal;
@@ -55,7 +31,7 @@
 @font-face {
     font-family: 'Merriweather';
     font-style: italic;
-    font-weight: 700i;
+    font-weight: 700;
     src: local('Merriweather Bold Italic'),url('@{FontPath}/merriweather/700i.woff') format('woff');
 }
 @font-face {
@@ -67,33 +43,9 @@
 @font-face {
     font-family: 'Merriweather';
     font-style: italic;
-    font-weight: 900i;
+    font-weight: 900;
     src: local('Merriweather Heavy Italic'),url('@{FontPath}/merriweather/900i.woff') format('woff');
 }
-@font-face {
-    font-family: 'Anonymous Pro';
-    font-style: normal;
-    font-weight: 400;
-    src: local('Anonymous Pro'),url('@{FontPath}/anonymouspro/400.woff') format('woff');
-}
-@font-face {
-    font-family: 'Anonymous Pro';
-    font-style: italic;
-    font-weight: 400i;
-    src: local('Anonymous Pro Italic'),url('@{FontPath}/anonymouspro/400i.woff') format('woff');
-}
-@font-face {
-    font-family: 'Anonymous Pro';
-    font-style: normal;
-    font-weight: 700;
-    src: local('Anonymous Pro Bold'),url('@{FontPath}/anonymouspro/700.woff') format('woff');
-}
-@font-face {
-    font-family: 'Anonymous Pro';
-    font-style: italic;
-    font-weight: 700i;
-    src: local('Anonymous Pro Bold Italic'),url('@{FontPath}/anonymouspro/700i.woff') format('woff');
-}
 @font-face {
     font-family: 'Open Sans';
     font-style: normal;
@@ -103,7 +55,7 @@
 @font-face {
     font-family: 'Open Sans';
     font-style: italic;
-    font-weight: 300i;
+    font-weight: 300;
     src: local('Open Sans Light Italic'),url('@{FontPath}/opensans/300i.woff') format('woff');
 }
 @font-face {
@@ -115,7 +67,7 @@
 @font-face {
     font-family: 'Open Sans';
     font-style: italic;
-    font-weight: 400i;
+    font-weight: 400;
     src: local('Open Sans Italic'),url('@{FontPath}/opensans/400i.woff') format('woff');
 }
 @font-face {
@@ -127,7 +79,7 @@
 @font-face {
     font-family: 'Open Sans';
     font-style: italic;
-    font-weight: 600i;
+    font-weight: 600;
     src: local('Open Sans Semibold Italic'),url('@{FontPath}/opensans/600i.woff') format('woff');
 }
 @font-face {
@@ -139,6 +91,6 @@
 @font-face {
     font-family: 'Open Sans';
     font-style: italic;
-    font-weight: 700i;
+    font-weight: 700;
     src: local('Open Sans Bold Italic'),url('@{FontPath}/opensans/700i.woff') format('woff');
 }

theme/stylesheets/website/header.less

@@ -13,7 +13,7 @@
         font-size: 0.85em;
         color: @header-color;
         background: @header-background;
-        box-shadow: 0 1px 2px hsla(200,10%,80%,0.6);
+        border-bottom: 1px solid @header-border;
 
         .btn {
             display: block;

theme/stylesheets/website/summary.less

@@ -11,7 +11,7 @@
         width: @sidebar-width;
         color: @sidebar-color;
         background: @sidebar-background;
-        box-shadow: inset -1px 0 5px hsla(0, 0%, 0%, 0.1);
+        border-right: 1px solid @sidebar-border;
 
         .transition(all 0.5s ease);
 
@@ -57,7 +57,6 @@
                     margin: 7px 0;
                     overflow: hidden;
                     background: @sidebar-divider-color;
-                    box-shadow: 0 1px rgba(255,255,255,0.7);
                 }
 
                 i.fa-check {

theme/stylesheets/website/variables.less

@@ -7,6 +7,7 @@
 @header-height:                       50px;
 @header-color:                        hsl(194, 5%, 52%);
 @header-background:                   white;
+@header-border:                       rgba(0, 0, 0, 0.07);
 @header-button-color:                 hsl(194, 5%, 52%);
 @header-button-hover-color:           #151515;
 @header-button-hover-background:      hsl(207, 15%, 95%);
@@ -18,28 +19,29 @@
 @sidebar-width:                       250px;
 @sidebar-breakpoint:                  600px;
 @sidebar-color:                       hsl(207, 15%, 80%);
-@sidebar-background:                  hsl(207, 15%, 95%);
+@sidebar-background:                  @body-background;
+@sidebar-border:                      @header-border;
 
 @sidebar-nested-padding:              20px;
 
 @sidebar-search-padding:              6px;
 @sidebar-search-background:           transparent;
-@sidebar-search-input-border-color:   hsl(207, 15%, 80%);
+@sidebar-search-input-border-color:   @sidebar-border;
 
-@sidebar-divider-color:               hsl(207, 15%, 85%);
+@sidebar-divider-color:               @sidebar-border;
 
-@sidebar-link-color:                  hsl(207, 15%, 50%);
+@sidebar-link-color:                  hsl(207, 15%, 25%);
 @sidebar-link-background:             transparent;
 @sidebar-link-hover-color:            hsl(207, 100%, 50%);
 @sidebar-link-hover-background:       transparent;
 
 @sidebar-icon-color:                  @bar-progress-background;
-@sidebar-link-completed:              hsl(207, 15%, 25%);
+@sidebar-link-completed:              @sidebar-link-color;
 @sidebar-link-completed-weight:       normal;
 
 // Page
-@page-color:                     			black;
-@page-background:                     white;
+@page-color:                          black;
+@page-background:                     @body-background;
 
 // Progress Bar
 @chapter-display:                     none;
@@ -76,19 +78,19 @@
 @border-radius-small:                 1px;
 
 // Fonts
-@font-family-serif:                   Merriweather, "EB Garamond", Georgia, serif;
+@font-family-serif:                   "Merriweather", Georgia, serif;
 @font-family-sans:                    "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
-@font-family-base:                    @font-family-serif;
-
+@font-family-base:                    @font-family-sans;
+@headings-font-family:                inherit;
 
 @FontPath:                            '@{staticPath}/fonts';
 @fa-font-path:                        "@{FontPath}/fontawesome";
 
-@s-font-size:													1.2rem;
-@m-font-size:													1.4rem;
-@l-font-size:													1.6rem;
-@xl-font-size:												2.2rem;
-@xxl-font-size:												4.0rem;
+@s-font-size:                                                   1.2rem;
+@m-font-size:                                                   1.4rem;
+@l-font-size:                                                   1.6rem;
+@xl-font-size:                                              2.2rem;
+@xxl-font-size:                                             4.0rem;
 
 /*
 ,--------.,--.
@@ -116,15 +118,15 @@
 // Sidebar
 @sidebar-color-1:                       #AFA790;
 @sidebar-color-2:                       hsl(207, 15%, 80%);
-@sidebar-background-1:                  #F3EACB;
-@sidebar-background-2:                  #111111;
+@sidebar-background-1:                  @body-background-1;
+@sidebar-background-2:                  @body-background-2;
 
 @sidebar-search-background-1:           transparent;
 @sidebar-search-background-2:           transparent;
 @sidebar-search-input-border-color-1:   #D6CFBA;
-@sidebar-search-input-border-color-2:   #c4cdd4;
+@sidebar-search-input-border-color-2:   #000;
 
-@sidebar-divider-color-1:               hsl(207, 15%, 85%);
+@sidebar-divider-color-1:               @sidebar-divider-color;
 @sidebar-divider-color-2:               #1d1f21;
 
 @sidebar-link-color-1:                  #877F6A;
@@ -138,14 +140,14 @@
 
 @sidebar-icon-color-1:                  @bar-progress-background;
 @sidebar-icon-color-2:                  @bar-progress-background;
-@sidebar-link-completed-1:              hsl(207, 15%, 25%);
-@sidebar-link-completed-2:              hsl(207, 15%, 25%);
+@sidebar-link-completed-1:              @sidebar-link-color-1;
+@sidebar-link-completed-2:              @sidebar-link-color-2;
 @sidebar-link-completed-weight-1:       normal;
 @sidebar-link-completed-weight-2:       normal;
 
 // Page
-@page-color-1:                     			#704214;
-@page-color-2:                     			#a4b1b1;
+@page-color-1:                              #704214;
+@page-color-2:                              #a4b1b1;
 @page-background-1:                     #F3EACB;
 @page-background-2:                     #1d1f21;
 

theme/templates/langs.html

@@ -10,7 +10,7 @@
         <ul class="languages">
         {%  for lang in langs %}
             <li>
-                <a href="{{ basePath}}/{{ lang.path }}">{{ lang.title }}</a>
+                <a href="{{ basePath}}/{{ lang.path|pathJoin("/index.html") }}">{{ lang.title }}</a>
             </li>
         {% endfor %}
         </ul>