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

Conflicts:
	theme/assets/print.css
	theme/assets/style.css

Author: codepiano

CHANGES.md

@@ -1,5 +1,12 @@
 # Release notes
 
+## 1.2.0
+- Improvements on ebook generation
+- Fix incorrect follow of links in ebook generation
+- Move Table of Contents at the beginning of the ebook
+- Update to last highlight.js (includes Swift)
+- Includes of templates and variables (from book.json)
+
 ## 1.1.1
 - Rewrite quiz logic to be more robust
 - Improve integration of glossary

README.md

@@ -111,6 +111,9 @@ Here are the options that can be stored in this file:
         }
     },
 
+    // Variables for templating
+    "variables": {},
+
     // Links in template (null: default, false: remove, string: new value)
     "links": {
     	// Custom links at top of sidebar
@@ -133,9 +136,6 @@ Here are the options that can be stored in this file:
 
     // 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,
 
@@ -248,7 +248,7 @@ The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books"
 
 #### Plugins
 
-Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
+Plugins can be used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
 
 ##### Official plugins:
 
@@ -258,6 +258,7 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
 | [quizzes](https://github.com/GitbookIO/plugin-quizzes) | Add interactive quizzes to your book. |
 | [mathjax](https://github.com/GitbookIO/plugin-mathjax) | Displays mathematical notation in the book. |
 | [mixpanel](https://github.com/GitbookIO/plugin-mixpanel) | Mixpanel tracking for your book |
+| [infinitescroll](https://github.com/GitbookIO/gitbook-plugin-infinitescroll) | Infinite Scrolling |
 
 ##### Other plugins:
 

lib/generate/config.js

@@ -38,6 +38,9 @@ var CONFIG = {
         }
     },
 
+    // 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

lib/generate/ebook/index.js

@@ -39,7 +39,8 @@ Generator.prototype.finish = function() {
             "--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,
-            "--max-levels": "1000"
+            "--max-levels": "1",
+            "--breadth-first": true
         };
 
         if (format == "pdf") {
@@ -50,7 +51,6 @@ Generator.prototype.finish = function() {
                 "--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),
                 "--pdf-mono-font-size": String(pdfOptions.fontSize),
                 "--paper-size": String(pdfOptions.paperSize),
@@ -62,7 +62,7 @@ Generator.prototype.finish = function() {
 
         var command = [
             "ebook-convert",
-            path.join(that.options.output, "index.html"),
+            path.join(that.options.output, "SUMMARY.html"),
             path.join(that.options.output, "index."+format),
             stringUtils.optionsToShellArgs(_options)
         ].join(" ");

lib/generate/generator.js

@@ -14,9 +14,6 @@ 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) {
@@ -25,22 +22,7 @@ BaseGenerator.prototype.callHook = function(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() {});
+    return this.loadPlugins();
 };
 
 BaseGenerator.prototype.loadPlugins = function() {

lib/generate/page/index.js

@@ -21,10 +21,25 @@ util.inherits(Generator, BaseGenerator);
 
 Generator.prototype.loadTemplates = function() {
     this.template = swig.compileFile(
-        this.plugins.template("page") || path.resolve(this.options.theme, 'templates/page.html')
+        this.plugins.template("ebook:page") || path.resolve(this.options.theme, 'templates/ebook/page.html')
+    );
+    this.summaryTemplate = swig.compileFile(
+        this.plugins.template("ebook:sumary") || path.resolve(this.options.theme, 'templates/ebook/summary.html')
     );
 };
 
+// Generate table of contents
+Generator.prototype.writeToc = function() {
+    var that = this;
+    var basePath = ".";
+
+    return this._writeTemplate(this.summaryTemplate, {
+        toc: parse.progress(this.options.navigation, "README.md").chapters,
+        basePath: basePath,
+        staticBase: path.join(basePath, "gitbook"),
+    }, path.join(this.options.output, "SUMMARY.html"));
+};
+
 Generator.prototype.finish = function() {
     var that = this;
     var basePath = ".";
@@ -34,6 +49,11 @@ Generator.prototype.finish = function() {
 
     return Q()
 
+    // Write table of contents
+    .then(function() {
+        return that.writeToc();
+    })
+
     // Copy cover
     .then(function() {
         return that.copyCover();

lib/generate/site/index.js

@@ -36,13 +36,13 @@ Generator.prototype.load = function() {
 // Load all templates
 Generator.prototype.loadTemplates = function() {
     this.template = swig.compileFile(
-        this.plugins.template("site") || path.resolve(this.options.theme, 'templates/site.html')
+        this.plugins.template("site:page") || path.resolve(this.options.theme, 'templates/book/page.html')
     );
     this.langsTemplate = swig.compileFile(
-        this.plugins.template("langs") || path.resolve(this.options.theme, 'templates/langs.html')
+        this.plugins.template("site:langs") || path.resolve(this.options.theme, 'templates/book/langs.html')
     );
     this.glossaryTemplate = swig.compileFile(
-        this.plugins.template("glossary") || path.resolve(this.options.theme, 'templates/glossary.html')
+        this.plugins.template("site:glossary") || path.resolve(this.options.theme, 'templates/book/glossary.html')
     );
 };
 
@@ -128,7 +128,7 @@ Generator.prototype.prepareFile  = function(content, _input) {
             // Output directory
             outdir: path.dirname(_input) || '/',
             // Templating variables
-            variables: that.variables,
+            variables: that.options.variables,
         });
     })
     .then(function(sections) {

lib/utils/string.js

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

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "1.1.1",
+    "version": "1.2.0",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -16,7 +16,7 @@
         "commander": "2.2.0",
         "graceful-fs": "3.0.2",
         "fs-extra": "0.10.0",
-        "highlight.js": "8.2.0",
+        "highlight.js": "8.3.0",
         "tmp": "0.0.23",
         "semver": "2.2.1",
         "gaze": "~0.5.1",