Merge branch 'master' of github.com:GitbookIO/gitbook

Conflicts:
	theme/assets/app.js
	theme/assets/print.css

Author: codepiano

CHANGES.md

@@ -1,5 +1,16 @@
 # Release notes
 
+## 1.1.1
+- Rewrite quiz logic to be more robust
+- Improve integration of glossary
+- Improve generation of ebook by using a multiple HTML pages input source
+- Fix incorrect page breaks after h1 and h2 divs
+- New options to set header and footer in PDF generation
+
+## 1.1.0
+- Plugins can now extend the ebook generation (pdf, epub, mobi)
+- Update `kramed` to version 0.4.3
+
 ## 1.0.3
 - Update `mathjax` plugin and MathJAx to version 2.4
 - Update `highlight.js` to 8.2.0

README.md

@@ -95,10 +95,6 @@ Here are the options that can be stored in this file:
     // 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/",
-
     // Plugins list, can contain "-name" for removing default plugins
     "plugins": [],
 
@@ -153,7 +149,13 @@ Here are the options that can be stored in this file:
             "left": 62,
             "top": 36,
             "bottom": 36
-        }
+        },
+
+        //Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
+        "headerTemplate": null,
+
+        //Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
+        "footerTemplate": null
     }
 }
 ```
@@ -166,7 +168,6 @@ GitBook can generate your book in the following formats:
 
 * **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
 * **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed. The output format could be **PDF**, **ePub** or **MOBI**.
-* **Single Page**: The book will be stored in a single printable HTML page. This format is used for conversion to PDF or eBook. Generate this format using: ```gitbook build ./myrepo -f page```.
 * **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
 
 ## Book Format
@@ -228,7 +229,7 @@ With it's definition, this can contain bold text and all other kinds of inline m
 
 GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files follows the same convention as `.gitignore`).
 
-Best practices for the `.gitignore` is to ignore build files from [**node.js**](https://github.com/github/gitignore/blob/master/Node.gitignore) (`node_modules`, ...) and build files from GitBook: `_book`, `*.epub`, `*.mobi` and `*.pdf`.
+Best practices for the `.gitignore` is to ignore build files from **node.js** (`node_modules`, ...) and build files from GitBook: `_book`, `*.epub`, `*.mobi` and `*.pdf` ([Download GitBook.gitignore](https://github.com/github/gitignore/blob/master/GitBook.gitignore)).
 
 #### Cover
 

lib/generate/config.js

@@ -83,7 +83,13 @@ var CONFIG = {
             "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": ""
     }
 };
 

lib/generate/ebook/index.js

@@ -9,10 +9,6 @@ var parse = require("../../parse");
 var BaseGenerator = require("../page");
 var stringUtils = require("../../utils/string");
 
-/*
- *  This generator inherits from the single page generator
- *  and convert the page output to ebook
- */
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
 };
@@ -35,12 +31,15 @@ Generator.prototype.finish = function() {
             "--title": that.options.title,
             "--comments": that.options.description,
             "--authors": that.options.author,
+            "--publisher": "GitBook",
             "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
             "--chapter-mark": "pagebreak",
+            "--page-breaks-before": "/",
             "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
             "--level2-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-2 ')]",
             "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]",
-            "--no-chapters-in-toc": true
+            "--no-chapters-in-toc": true,
+            "--max-levels": "1000"
         };
 
         if (format == "pdf") {
@@ -55,7 +54,9 @@ Generator.prototype.finish = function() {
                 "--pdf-default-font-size": String(pdfOptions.fontSize),
                 "--pdf-mono-font-size": String(pdfOptions.fontSize),
                 "--paper-size": String(pdfOptions.paperSize),
-                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers)
+                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers),
+                "--pdf-header-template": String(pdfOptions.headerTemplate),
+                "--pdf-footer-template": String(pdfOptions.footerTemplate)
             });
         }
 

lib/generate/generator.js

@@ -14,12 +14,35 @@ var BaseGenerator = function(options) {
     this.options.plugins = Plugin.normalizeNames(this.options.plugins);
     this.options.plugins = _.union(this.options.plugins, this.options.defaultsPlugins);
     this.plugins = [];
+
+    // Include variables (not yet loaded)
+    this.variables = {};
 };
 
 BaseGenerator.prototype.callHook = function(name, data) {
     return this.plugins.hook(name, data);
 };
 
+// Sets up generator
+BaseGenerator.prototype.load = function() {
+    return this.loadVariables()
+    .then(this.loadPlugins.bind(this));
+};
+
+BaseGenerator.prototype.loadVariables = function() {
+    var that = this;
+
+    return fs.readFile(path.join(this.options.input, 'variables.json'), 'utf8')
+    .then(function(content) {
+        try {
+            that.variables = JSON.parse(content);
+        } catch(err) {
+            console.log('No variables.json');
+        }
+    })
+    .fail(function() {});
+};
+
 BaseGenerator.prototype.loadPlugins = function() {
     var that = this;
 
@@ -79,6 +102,4 @@ BaseGenerator.prototype.finish = function() {
     return Q.reject(new Error("Could not finish generation"));
 };
 
-
-
-module.exports = BaseGenerator;
+module.exports = BaseGenerator;

lib/generate/index.js

@@ -40,7 +40,7 @@ var loadGenerator = function(options) {
     .then(function() {
         var generator = new generators[options.generator](options);
 
-        return generator.loadPlugins()
+        return generator.load()
         .then(_.constant(generator));
     });
 };

lib/generate/json/index.js

@@ -73,4 +73,4 @@ Generator.prototype.finish = function() {
     // ignore
 };
 
-module.exports = Generator;
+module.exports = Generator;

lib/generate/page/index.js

@@ -8,10 +8,6 @@ var fs = require("../fs");
 var parse = require("../../parse");
 var BaseGenerator = require("../site");
 
-
-/*
- *  This generator will generate a simple index.html which can be converted as a PDF
- */
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
 
@@ -23,31 +19,12 @@ var Generator = function() {
 };
 util.inherits(Generator, BaseGenerator);
 
-// Load all templates
 Generator.prototype.loadTemplates = function() {
     this.template = swig.compileFile(
         this.plugins.template("page") || path.resolve(this.options.theme, 'templates/page.html')
     );
 };
 
-Generator.prototype.convertFile = function(content, input) {
-    var that = this;
-    var json = {
-        path: input,
-        progress: parse.progress(this.options.navigation, input)
-    };
-
-    return this.prepareFile(content, input)
-    .then(function(page) {
-        that.pages[input] = page;
-    });
-};
-
-// Generate languages index
-Generator.prototype.langsIndex = function(langs) {
-    return Q();
-};
-
 Generator.prototype.finish = function() {
     var that = this;
     var basePath = ".";
@@ -56,16 +33,6 @@ Generator.prototype.finish = function() {
     var progress = parse.progress(this.options.navigation, "README.md");
 
     return Q()
-    // Generate html
-    .then(function(pages) {
-        return that._writeTemplate(that.template, {
-            pages: that.pages,
-            progress: progress,
-
-            basePath: basePath,
-            staticBase: path.join(basePath, "gitbook"),
-        }, output);
-    })
 
     // Copy cover
     .then(function() {
@@ -78,4 +45,9 @@ Generator.prototype.finish = function() {
     });
 };
 
-module.exports = Generator;
+// Generate languages index
+Generator.prototype.langsIndex = function(langs) {
+    return Q();
+};
+
+module.exports = Generator;

lib/generate/plugin.js

@@ -8,7 +8,7 @@ var resolve = require('resolve');
 
 var pkg = require("../../package.json");
 
-var  RESOURCES = ["js", "css"];
+var RESOURCES = ["js", "css"];
 
 var Plugin = function(name, root, generator) {
     this.name = name;

lib/generate/site/glossary_indexer.js

@@ -1,5 +1,4 @@
 var _ = require("lodash");
-
 var kramed = require('kramed');
 var textRenderer = require('kramed-text-renderer');