Bump version to 1.4.1

add X-UA-Compatible meta tag for IE

CHANGES.md

@@ -1,5 +1,39 @@
 # Release notes
 
+## 1.4.1
+- Fix command 'install' without arguments
+
+## 1.4.0
+- Add command `gitbook install` to install plugins from book.json
+- `package.json` is no longer necessary
+
+## 1.3.4
+- Add glossary to ebooks
+- Fix autocover with new hook "finish:before"
+- Add X-UA-Compatible meta tag for IE
+
+## 1.3.3
+- Fix parsing of lexed content using the client library
+
+## 1.3.2
+- ePub files are now passing validation from epubcheck
+- Fix replacement of multiple glossary terms in a single sentence
+- Fix on windows deep relative links
+- Fix search indexer
+
+## 1.3.1
+- Fix error with links in markdown
+
+## 1.3.0
+- Bundle gitbook parsing library as a client side library in `gitbook.js` and `gitbook.min.js`
+
+## 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

Gruntfile.js

@@ -6,6 +6,8 @@ module.exports = function (grunt) {
     grunt.loadNpmTasks('grunt-contrib-less');
     grunt.loadNpmTasks('grunt-contrib-requirejs');
     grunt.loadNpmTasks("grunt-bower-install-simple");
+    grunt.loadNpmTasks('grunt-browserify');
+    grunt.loadNpmTasks('grunt-contrib-uglify');
 
     // Init GRUNT configuraton
     grunt.initConfig({
@@ -77,6 +79,30 @@ module.exports = function (grunt) {
                     }
                 ]
             }
+        },
+        browserify: {
+            dist: {
+                files: {
+                    'gitbook.js': [
+                        './lib/parse/index.js'
+                    ],
+                },
+                options: {
+                    postBundleCB: function (err, src, next) {
+                        return next(null, '(function () { var define = undefined; '+src+'; })();')
+                    },
+                    browserifyOptions: {
+                        'standalone': "gitbook"
+                    }
+                }
+            }
+        },
+        uglify: {
+            dist: {
+                files: {
+                    'gitbook.min.js': ['gitbook.js']
+                }
+            }
         }
     });
 
@@ -90,7 +116,14 @@ module.exports = function (grunt) {
         'copy:vendors'
     ]);
 
+    // Bundle the library
+    grunt.registerTask('bundle', [
+        'browserify',
+        'uglify'
+    ]);
+
     grunt.registerTask('default', [
-        'build'
+        'build',
+        'bundle'
     ]);
 };

README.md

@@ -74,6 +74,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
@@ -94,9 +97,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,
 
@@ -132,7 +132,10 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb
 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**.
+* **eBook**: A complete eBook with exercise solutions at the end of the book.  You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.  You can specify the eBook filename with the `-o` option, otherwise `book` will be used.
+  * Generate a **PDF** using:  `gitbook pdf ./myrepo`
+  * Generate a **ePub** using: `gitbook epub ./myrepo`
+  * Generate a **MOBI** using: `gitbook mobi ./myrepo`
 * **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
 
 ## Book Format
@@ -209,7 +212,9 @@ 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.
+
+Plugins needed to build a book can be installed using: `gitbook install ./`.
 
 ##### Official plugins:
 
@@ -219,6 +224,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:
 
@@ -235,6 +241,8 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
 | [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik) | Piwik Open Analytics tracking for your book |
 | [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors) | Add linkable Github-style anchors to headings |
 | [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin) | Embedded jsbin frame into your book |
+| [gitbook-grvis](https://github.com/romanlytkin/gitbook-grvis) | Gitbook GrViz plugin is used to select from markdown dot and converting it into a picture format svg |
+| [gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml) | Gitbook PlantUml plugin is used to select from markdown uml and converting it into a picture format svg |
 
 #### Debugging
 

bin/gitbook.js

@@ -7,7 +7,7 @@ var prog = require('commander');
 var tinylr = require('tiny-lr-fork');
 
 var pkg = require('../package.json');
-var generators = require("../lib/generate").generators;
+var genbook = require("../lib/generate");
 var initDir = require("../lib/generate/init");
 var fs = require('../lib/generate/fs');
 
@@ -80,6 +80,30 @@ build.command(prog.command('serve [source_dir]'))
     generate();
 });
 
+build.commandEbook(prog.command('install [source_dir]'))
+.description('Install plugins for a book')
+.action(function(dir, options) {
+    dir = dir || process.cwd();
+    
+    console.log("Install plugins in", dir);
+    genbook.config.read({
+        input: dir
+    })
+    .then(function(options) {
+        return genbook.Plugin.install(options);
+    })
+    .then(function() {
+        console.log("Successfully installed plugins!");
+    })
+    .fail(function(err) {
+        // Log error
+        utils.logError(err);
+
+        // Exit process with failure code
+        process.exit(-1);
+    });
+});
+
 build.commandEbook(prog.command('pdf [source_dir]'))
 .description('Build a gitbook as a PDF')
 .action(function(dir, options) {

lib/generate/config.js

@@ -1,3 +1,4 @@
+var Q = require('q');
 var _ = require('lodash');
 var path = require('path');
 
@@ -38,6 +39,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
@@ -93,10 +97,32 @@ var CONFIG = {
     }
 };
 
+// Return complete configuration
+var defaultsConfig = function(options) {
+    return _.merge(options || {}, CONFIG, _.defaults);
+};
+
+// Read configuration from book.json
+var readConfig = function(options) {
+    options = defaultsConfig(options);
+
+    return Q()
+    .then(function() {
+        try {
+            var _config = require(path.resolve(options.input, options.configFile));
+            options = _.merge(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins', 'generator'));
+        }
+        catch(err) {
+            // No config file: not a big deal
+            return Q();
+        }
+    })
+    .thenResolve(options);
+};
+
 module.exports = {
     CONFIG: CONFIG,
-    defaults: function(options) {
-        return _.merge(options || {}, CONFIG, _.defaults);
-    }
+    defaults: defaultsConfig,
+    read: readConfig
 }
 

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/fs.js

@@ -74,4 +74,5 @@ module.exports = {
         fs.exists(path, d.resolve);
         return d.promise;
     },
+    readFileSync: fs.readFileSync.bind(fs)
 };

lib/generate/generator.js

@@ -20,6 +20,11 @@ BaseGenerator.prototype.callHook = function(name, data) {
     return this.plugins.hook(name, data);
 };
 
+// Sets up generator
+BaseGenerator.prototype.load = function() {
+    return this.loadPlugins();
+};
+
 BaseGenerator.prototype.loadPlugins = function() {
     var that = this;
 

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));
     });
 };
@@ -48,28 +48,18 @@ var loadGenerator = function(options) {
 
 
 var generate = function(options) {
-    // Set defaults to options
-    options = defaultConfig.defaults(options);
-
-    // Validate options
-    if (!options.input) {
-        return Q.reject(new Error("Need option input (book input directory)"));
-    }
-
-    // Check files to get folder type (book, multilanguage book or neither)
-    return checkGenerator(options)
-
     // Read config file
-    .then(function() {
-        try {
-            var _config = require(path.resolve(options.input, options.configFile));
+    return defaultConfig.read(options)
+    .then(function(_options) {
+        options = _options;
 
-            options = _.merge(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins'));
-        }
-        catch(err) {
-            // No config file: not a big deal
-            return Q();
+        // Validate options
+        if (!options.input) {
+            return Q.reject(new Error("Need option input (book input directory)"));
         }
+
+        // Check files to get folder type (book, multilanguage book or neither)
+        return checkGenerator(options);
     })
 
     // Read readme
@@ -99,7 +89,9 @@ var generate = function(options) {
     });
 };
 
-
+/*
+ *  Generate a multilanguage book by generating a book for each folder.
+ */
 var generateMultiLang = function(options) {
     var langsSummary;
     options.output = options.output || path.join(options.input, "_book");
@@ -297,6 +289,9 @@ var generateBook = function(options) {
         })
 
         // Finish generation
+        .then(function() {
+            return generator.callHook("finish:before");
+        })
         .then(function() {
             return generator.finish();
         })
@@ -375,4 +370,5 @@ module.exports = {
     file: generateFile,
     book: generateBook,
     Plugin: Plugin,
+    config: defaultConfig
 };

lib/generate/json/index.js

@@ -29,8 +29,9 @@ Generator.prototype.convertFile = function(content, input) {
             dir: path.dirname(input) || '/'
         });
     })
-    .then(function(sections) {
-        json.sections = sections;
+    .then(function(parsed) {
+        json.lexed = parsed.lexed;
+        json.sections = parsed.sections;
     })
     .then(function() {
         return fs.writeFile(

lib/generate/page/index.js

@@ -21,8 +21,26 @@ 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')
+    );
+    this.glossaryTemplate = swig.compileFile(
+        this.plugins.template("ebook:glossary") || path.resolve(this.options.theme, 'templates/ebook/glossary.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() {
@@ -31,9 +49,19 @@ Generator.prototype.finish = function() {
     var output = path.join(this.options.output, "index.html");
 
     var progress = parse.progress(this.options.navigation, "README.md");
-
+    
     return Q()
 
+    // Write table of contents
+    .then(function() {
+        return that.writeToc();
+    })
+
+    // Write glossary
+    .then(function() {
+        return that.writeGlossary();
+    })
+
     // Copy cover
     .then(function() {
         return that.copyCover();

lib/generate/plugin.js

@@ -4,6 +4,7 @@ var semver = require("semver");
 var path = require("path");
 var url = require("url");
 var fs = require("./fs");
+var npmi = require('npmi');
 var resolve = require('resolve');
 
 var pkg = require("../../package.json");
@@ -152,33 +153,73 @@ Plugin.prototype.copyAssets = function(out, options) {
 };
 
 
-// Normalize a list of plugin name to use
-Plugin.normalizeNames = function(names) {
+// Install a list of plugin
+Plugin.install = function(options) {
+    // Normalize list of plugins
+    var plugins = Plugin.normalizeList(options.plugins);
+
+    // Install plugins one by one
+    return _.reduce(plugins, function(prev, plugin) {
+        return prev.then(function() {
+            var fullname = "gitbook-plugin-"+plugin.name;
+            console.log("Install plugin", plugin.name, "from npm ("+fullname+") with version", (plugin.version || "*"));
+            return Q.nfcall(npmi, {
+                'name': fullname,
+                'version': plugin.version,
+                'path': options.input,
+                'npmLoad': {
+                    'loglevel': 'silent',
+                    'loaded': false,
+                    'prefix': options.input
+                }
+            });
+        });
+    }, Q());
+};
+
+// Normalize a list of plugins to use
+Plugin.normalizeList = function(plugins) {
     // Normalize list to an array
-    names = _.isString(names) ? names.split(",") : (names || []);
+    plugins = _.isString(plugins) ? plugins.split(",") : (plugins || []);
+
+    // Divide as {name, version} to handle format like "myplugin@1.0.0"
+    plugins = _.map(plugins, function(plugin) {
+        var parts = plugin.split("@");
+        return {
+            'name': parts[0],
+            'version': parts[1] // optional
+        }
+    });
 
     // List plugins to remove
-    var toremove = _.chain(names)
-    .filter(function(name) {
-        return name.length > 0 && name[0] == "-";
+    var toremove = _.chain(plugins)
+    .filter(function(plugin) {
+        return plugin.name.length > 0 && plugin.name[0] == "-";
     })
-    .map(function(name) {
-        return name.slice(1);
+    .map(function(plugin) {
+        return plugin.name.slice(1);
     })
     .value();
 
     // Merge with defaults
-    names = _.chain(names)
-    .concat(Plugin.defaults)
+    plugins = _.chain(plugins)
+    .concat(_.map(Plugin.defaults, function(plugin) {
+        return { 'name': plugin }
+    }))
     .uniq()
     .value();
 
-    // Remove plugins starting with
-    names = _.filter(names, function(name) {
-        return !_.contains(toremove, name) && !(name.length > 0 && name[0] == "-");
+    // Build final list
+    plugins = _.filter(plugins, function(plugin) {
+        return !_.contains(toremove, plugin.name) && !(plugin.name.length > 0 && plugin.name[0] == "-");
     });
 
-    return names;
+    return plugins;
+};
+
+// Normalize a list of plugin name to use
+Plugin.normalizeNames = function(plugins) {
+    return _.pluck(Plugin.normalizeList(plugins), "name");
 };
 
 // Extract data from a list of plugin
@@ -196,7 +237,7 @@ Plugin.fromList = function(names, root, generator, options) {
         return plugin;
     });
 
-    if (_.size(failed) > 0) return Q.reject(new Error("Error loading plugins: "+failed.join(",")));
+    if (_.size(failed) > 0) return Q.reject(new Error("Error loading plugins: "+failed.join(",")+". Run 'gitbook install' to install plugins from NPM."));
 
     // The raw resources extracted from each plugin
     var pluginResources;
@@ -276,7 +317,7 @@ Plugin.fromList = function(names, root, generator, options) {
     });
 };
 
-// Default plugins
+// Default plugins added to each books
 Plugin.defaults = [
     "mathjax"
 ];

lib/generate/site/index.js

@@ -23,29 +23,29 @@ var Generator = function() {
 };
 util.inherits(Generator, BaseGenerator);
 
-// Load all templates
-Generator.prototype.loadTemplates = function() {
-    this.template = swig.compileFile(
-        this.plugins.template("site") || path.resolve(this.options.theme, 'templates/site.html')
-    );
-    this.langsTemplate = swig.compileFile(
-        this.plugins.template("langs") || path.resolve(this.options.theme, 'templates/langs.html')
-    );
-    this.glossaryTemplate = swig.compileFile(
-        this.plugins.template("glossary") || path.resolve(this.options.theme, 'templates/glossary.html')
-    );
-};
-
-// Load plugins
-Generator.prototype.loadPlugins = function() {
+// Add template loading to load
+Generator.prototype.load = function() {
     var that = this;
 
-    return BaseGenerator.prototype.loadPlugins.apply(this)
+    return BaseGenerator.prototype.load.apply(this)
     .then(function() {
         return that.loadTemplates();
     });
 };
 
+// Load all templates
+Generator.prototype.loadTemplates = function() {
+    this.template = swig.compileFile(
+        this.plugins.template("site:page") || path.resolve(this.options.theme, 'templates/book/page.html')
+    );
+    this.langsTemplate = swig.compileFile(
+        this.plugins.template("site:langs") || path.resolve(this.options.theme, 'templates/book/langs.html')
+    );
+    this.glossaryTemplate = swig.compileFile(
+        this.plugins.template("site:glossary") || path.resolve(this.options.theme, 'templates/book/glossary.html')
+    );
+};
+
 // Generate a template
 Generator.prototype._writeTemplate = function(tpl, options, output, interpolate) {
     var that = this;
@@ -118,20 +118,25 @@ Generator.prototype.prepareFile  = function(content, _input) {
         return _callHook("page:before");
     })
     .then(function() {
-        // Lex page
-        return parse.lex(page.content);
-    })
-    .then(function(lexed) {
-        page.lexed = lexed;
-
+        // Lex, parse includes and get
         // Get HTML generated sections
-        return parse.page(lexed, {
+        return parse.page(page.content, {
+            // Local files path
             dir: path.dirname(_input) || '/',
+
+            // Output directory
             outdir: path.dirname(_input) || '/',
+
+            // Includer for templating
+            includer: parse.includer(that.options.variables, [
+                    path.dirname(_input) || '/',
+                    path.join(that.options.input, '_includes'),
+            ], path.join, fs.readFileSync)
         });
     })
-    .then(function(sections) {
-        page.sections = sections;
+    .then(function(parsed) {
+        page.lexed = parsed.lexed;
+        page.sections = parsed.sections;
 
         // Use plugin hook
         return _callHook("page");
@@ -149,7 +154,12 @@ Generator.prototype.convertFile = function(content, _input) {
     if (_output == "README.html") _output = "index.html";
     var output = path.join(this.options.output, _output);
     var basePath = path.relative(path.dirname(output), this.options.output) || ".";
-
+	
+	// Bug fix for issue #493 which would occur when relative-links are 2-level or more deep in win32
+	if (process.platform === 'win32') {
+		basePath = basePath.replace(/\\/g, '/');
+	}
+	
     return this.prepareFile(content, _input)
     .then(function(page) {
         // Index page in search

lib/parse/code_include.js

@@ -1,20 +0,0 @@
-var fs = require('graceful-fs');
-var path = require('path');
-
-module.exports = function(code, folder) {
-    folder = folder || '';
-
-    return code.replace(/{{([\s\S]+?)}}/g, function(match, filename) {
-        // Normalize filename
-        var fname = path.join(folder, filename.trim());
-
-        // Try including snippet from FS
-        try {
-            // Trim trailing newlines/space of imported snippets
-            return fs.readFileSync(fname, 'utf8').trimRight();
-        } catch(err) {}
-
-        // If fails leave content as is
-        return match;
-    });
-};

lib/parse/include.js

@@ -0,0 +1,12 @@
+var _ = require('lodash');
+
+module.exports = function(markdown, includer) {
+    // Memoized include function (to cache lookups)
+    var _include = _.memoize(includer);
+
+    return markdown.replace(/{{([\s\S]+?)}}/g, function(match, key) {
+        // If fails leave content as is
+        key = key.trim();
+        return _include(key) || match;
+    });
+};

lib/parse/includer.js

@@ -0,0 +1,15 @@
+// Return a fs inclduer
+module.exports = function(ctx, folders, resolveFile, readFile) {
+    return function(name) {
+        return ctx[name] ||
+        folders.map(function(folder) {
+            // Try including snippet from FS
+            try {
+                var fname = resolveFile(folder, name);
+                // Trim trailing newlines/space of imported snippets
+                return readFile(fname, 'utf8').trimRight();
+            } catch(err) {}
+        })
+        .filter(Boolean)[0];
+    }
+};

lib/parse/index.js

@@ -6,5 +6,6 @@ module.exports = {
     lex: require('./lex'),
     progress: require('./progress'),
     navigation: require('./navigation'),
-    readme: require('./readme')
+    readme: require('./readme'),
+    includer: require('./includer')
 };

lib/parse/page.js

@@ -5,7 +5,7 @@ var hljs = require('highlight.js');
 var lex = require('./lex');
 var renderer = require('./renderer');
 
-var codeInclude = require('./code_include');
+var include = require('./include');
 var lnormalize = require('../utils/lang').normalize;
 
 
@@ -51,8 +51,10 @@ function parsePage(src, options) {
     options = options || {};
 
     // Lex if not already lexed
-    return (_.isArray(src) ? src : lex(src))
-    .map(function(section) {
+    var parsed = {
+        lexed: (_.isArray(src) ? src : lex(include(src, options.includer || function() { return undefined; })))
+    };
+    parsed.sections = parsed.lexed.map(function(section) {
         // Transform given type
         if(section.type === 'exercise') {
             var nonCodeNodes = _.reject(section, {
@@ -74,20 +76,15 @@ function parsePage(src, options) {
             // Main language
             var lang = validLangs ? langs[0] : null;
 
-            // codeInclude shortcut
-            var ci = function(code) {
-                return codeInclude(code, options.dir);
-            };
-
             return {
                 id: section.id,
                 type: section.type,
                 content: render(nonCodeNodes, options),
                 lang: lang,
                 code: {
-                    base: ci(codeNodes[0].text),
-                    solution: ci(codeNodes[1].text),
-                    validation: ci(codeNodes[2].text),
+                    base: codeNodes[0].text,
+                    solution: codeNodes[1].text,
+                    validation: codeNodes[2].text,
                     // Context is optional
                     context: codeNodes[3] ? codeNodes[3].text : null,
                 }
@@ -155,6 +152,8 @@ function parsePage(src, options) {
             content: render(section, options)
         };
     });
+
+    return parsed;
 }
 
 // Exports

lib/parse/renderer.js

@@ -1,11 +1,7 @@
 var url = require('url');
+var _ = require('lodash');
 var inherits = require('util').inherits;
 var links = require('../utils').links;
-var codeInclude = require('./code_include');
-
-
-var path = require('path');
-
 var kramed = require('kramed');
 
 var rendererId = 0;
@@ -52,11 +48,11 @@ GitBookRenderer.prototype.link = function(href, title, text) {
 
     // Parsed version of the url
     var parsed = url.parse(href);
-
     var o = this._extra_options;
+    var extname = parsed.path? _.last(parsed.path.split(".")) : "";
 
     // Relative link, rewrite it to point to github repo
-    if(links.isRelative(_href) && path.extname(parsed.path) == ".md") {
+    if(links.isRelative(_href) && extname == "md") {
         _href = links.toAbsolute(_href, o.dir || "./", o.outdir || "./");
         _href = _href.replace(".md", ".html");
     }
@@ -130,8 +126,7 @@ GitBookRenderer.prototype.listitem = function(text) {
 GitBookRenderer.prototype.code = function(code, lang, escaped) {
     return GitBookRenderer.super_.prototype.code.call(
         this,
-        // Import code snippets
-        codeInclude(code, this._extra_options.dir),
+        code,
         lang,
         escaped
     );

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.4.1",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -16,9 +16,10 @@
         "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",
+        "npmi": "0.1.1",
         "gaze": "~0.5.1",
         "resolve": "0.6.3",
         "tiny-lr-fork": "0.0.5",
@@ -35,7 +36,9 @@
         "grunt-contrib-copy": "0.5.0",
         "grunt-contrib-less": "~0.5.0",
         "grunt-contrib-requirejs": "0.4.1",
-        "grunt-bower-install-simple": "0.9.2"
+        "grunt-bower-install-simple": "0.9.2",
+        "grunt-browserify": "3.1.0",
+        "grunt-contrib-uglify": "0.6.0"
     },
     "scripts": {
         "test": "export TESTING=true; mocha --reporter list"

test/includes.js

@@ -3,12 +3,13 @@ var path = require('path');
 var assert = require('assert');
 
 var page = require('../').parse.page;
+var includer = require('../').parse.includer;
 
 var FIXTURES_DIR = path.join(__dirname, './fixtures/');
 
 function loadPage (name, options) {
     var CONTENT = fs.readFileSync(FIXTURES_DIR + name + '.md', 'utf8');
-    return page(CONTENT, options);
+    return page(CONTENT, options).sections;
 }
 
 
@@ -16,6 +17,9 @@ describe('Code includes', function() {
 
     var LEXED = loadPage('INCLUDES', {
         'dir': FIXTURES_DIR,
+        'includer': includer({}, [
+            FIXTURES_DIR
+        ], path.join, fs.readFileSync)
     });
 
     var INCLUDED_C = fs.readFileSync(path.join(FIXTURES_DIR, 'included.c'), 'utf8');

test/page.js

@@ -6,7 +6,7 @@ var page = require('../').parse.page;
 
 function loadPage (name, options) {
     var CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/' + name + '.md'), 'utf8');
-    return page(CONTENT, options);
+    return page(CONTENT, options).sections;
 }
 
 var LEXED = loadPage('PAGE', {
@@ -80,9 +80,6 @@ describe('Page parsing', function() {
 describe('Relative links', function() {
     it('should replace link to .md by link to .html', function() {
         var LEXED = loadPage('MARKDOWN_LINKS', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'course',
             outdir: 'course'
@@ -96,9 +93,6 @@ describe('Relative links', function() {
 describe('Relative images', function() {
     it('should keep image relative with considering output directory in site format', function() {
         var LEXED = loadPage('IMAGES', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'syntax',
             outdir: 'syntax'
@@ -110,9 +104,6 @@ describe('Relative images', function() {
 
     it('should keep image relative with considering output directory in page format', function() {
         var LEXED = loadPage('IMAGES', {
-            // GitHub repo ID
-            repo: 'GitBookIO/javascript',
-
             // Imaginary folder of markdown file
             dir: 'syntax',
             outdir: './'

test/plugin.js

@@ -12,7 +12,7 @@ describe('Plugin validation', function () {
     });
 });
 
-describe('Plugin list of names', function () {
+describe('Plugins list', function () {
     var firstDefault = _.first(Plugin.defaults);
 
     it('should convert string to array', function() {
@@ -27,6 +27,15 @@ describe('Plugin list of names', function () {
     it('should remove name starting with -', function() {
         assert(!_.contains(Plugin.normalizeNames(["-"+firstDefault]), firstDefault));
     });
+
+    it('should accept version', function() {
+        var _name = "test@0.3.0,exercises@1.2.0,test2";
+        var plugins = Plugin.normalizeList(_name);
+
+        assert(_.find(plugins, {'name': "test"}).version = "0.3.0");
+        assert(_.find(plugins, {'name': "exercises"}).version = "1.2.0");
+        assert(!_.find(plugins, {'name': "test2"}).version);
+    });
 });
 
 describe('Plugin defaults loading', function () {

theme/javascript/core/glossary.js

@@ -31,21 +31,57 @@ define([
         return d.promise();
     }
 
+    $.fn.replaceText = function( search, replace, text_only ) {
+        return this.each(function(){
+            var node = this.firstChild,
+                val,
+                new_val,
 
+                // Elements to be removed at the end.
+                remove = [];
+
+            // Only continue if firstChild exists.
+            if ( node ) {
+
+                // Loop over all childNodes.
+                do {
+
+                    // Only process text nodes.
+                    if ( node.nodeType === 3 ) {
+
+                        // The original node value.
+                        val = node.nodeValue;
+
+                        // The new value.
+                        new_val = val.replace( search, replace );
+
+                        // Only replace text if the new value is actually different!
+                        if ( new_val !== val ) {
+
+                            if ( !text_only && /</.test( new_val ) ) {
+                                // The new value contains HTML, set it in a slower but far more
+                                // robust way.
+                                $(node).before( new_val );
+
+                                // Don't remove the node yet, or the loop will lose its place.
+                                remove.push( node );
+                            } else {
+                                // The new value contains no HTML, so it can be set in this
+                                // very fast, simple way.
+                                node.nodeValue = new_val;
+                            }
+                        }
+                    }
+
+                } while ( node = node.nextSibling );
+            }
+
+            // Time to remove those elements!
+            remove.length && $(remove).remove();
+        });
+    };
 
     var pregQuote = function( str ) {
-        // http://kevin.vanzonneveld.net
-        // +   original by: booeyOH
-        // +   improved by: Ates Goral (http://magnetiq.com)
-        // +   improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
-        // +   bugfixed by: Onno Marsman
-        // *     example 1: preg_quote("$40");
-        // *     returns 1: '\$40'
-        // *     example 2: preg_quote("*RRRING* Hello?");
-        // *     returns 2: '\*RRRING\* Hello\?'
-        // *     example 3: preg_quote("\\.+*?[^]$(){}=!<>|:");
-        // *     returns 3: '\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:'
-
         return (str+'').replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, "\\$1");
     };
 
@@ -58,48 +94,13 @@ define([
         });
     };
 
-    var matchText = function(node, regex, callback, excludeElements) {
-        excludeElements || (excludeElements = ['script', 'style', 'iframe', 'canvas']);
-        var child = node.firstChild;
-
-        if (!child) return;
-
-        do {
-            switch (child.nodeType) {
-            case 1:
-                if (excludeElements.indexOf(child.tagName.toLowerCase()) > -1) {
-                    continue;
-                }
-                matchText(child, regex, callback, excludeElements);
-                break;
-            case 3:
-               child.data.replace(regex, function(all) {
-                    var args = [].slice.call(arguments),
-                        offset = args[args.length - 2],
-                        newTextNode = child.splitText(offset);
-
-                    newTextNode.data = newTextNode.data.substr(all.length);
-                    callback.apply(window, [child].concat(args));
-                    child = newTextNode;
-                });
-                break;
-            }
-        } while (child = child.nextSibling);
-
-        return node;
-    };
-
     var replaceTerm = function($el, term) {
         var r =  new RegExp( "\\b(" + pregQuote(term.name.toLowerCase()) + ")\\b" , 'gi' );
 
-        matchText($el.get(0), r, function(node, match, offset) {
-            var span = document.createElement("span");
-            span.className = "glossary-term";
-            span.textContent = match;
-            span.setAttribute("data-glossary-term", term.id);
-            span.setAttribute("title", term.description);
-            node.parentNode.insertBefore(span, node.nextSibling);
+        $el.find("*").replaceText(r, function(match) {
+            return "<span class='glossary-term' data-glossary-term='"+term.id+"' title='"+term.description+"'>"+match+"</span>";
         });
+
     };
 
     var prepare = function() {

theme/stylesheets/base/markdown.less

@@ -256,7 +256,8 @@
     }
 
     ol ol,
-    ol ul {
+    ol ul,
+    ul ul {
         margin-top: 0;
         margin-bottom: 0;
     }

theme/stylesheets/ebook.less

@@ -4,6 +4,12 @@
 @import "ebook/highlight.less";
 
 .page {
+    &.page-toc {
+        ol {
+            margin: 0px;
+        }
+    }
+
     .book-chapter {
         display: none;
     }

theme/templates/book/glossary.html

@@ -1,4 +1,4 @@
-{% extends "site.html" %}
+{% extends "page.html" %}
 
 {% block title %}Glossary | {{ title }}{% endblock %}
 

theme/templates/book/langs.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "../layout.html" %}
 
 {% block title %}{{ title }}{% endblock %}
 

theme/templates/book/page.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "../layout.html" %}
 
 {% block head %}
     {% parent %}
@@ -15,10 +15,10 @@
 
 {% block content %}
     <div class="book" data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">
-    {% include "includes/book/summary.html" %}
+    {% include "includes/summary.html" %}
     <div class="book-body">
         <div class="body-inner">
-            {% include "includes/book/header.html" %}
+            {% include "includes/header.html" %}
             <div class="page-wrapper" tabindex="-1">
                 <div class="page-inner">
                 {% block page_inner %}
@@ -27,9 +27,9 @@
                     {% if section.type == "normal" %}
                         {% autoescape false %}{{ section.content }}{% endautoescape %}
                     {% elif section.type == "exercise" %}
-                        {% include "./includes/book/exercise.html" with {section: section} %}
+                        {% include "./includes/exercise.html" with {section: section} %}
                     {% elif section.type == "quiz" %}
-                        {% include "./includes/book/quiz.html" with {section: section} %}
+                        {% include "./includes/quiz.html" with {section: section} %}
                     {% endif %}
                     </section>
                 {% endfor %}

theme/templates/ebook/glossary.html

@@ -0,0 +1,15 @@
+{% extends "./layout.html" %}
+
+{% block title %}Glossary | {{ title }}{% endblock %}
+
+{% block content %}
+<div class="page page-toc">
+    <h1>Glossary</h1>
+	{% for item in glossaryIndex %}
+	<section class="normal glossary" id="{{ item.id }}">
+	    <h2><a href="#{{ item.id }}">{{ item.name }}</a></h2>
+	    <p>{{ item.description }}</p>
+	</section>
+	{% endfor %}
+</div>
+{% endblock %}

theme/templates/ebook/layout.html

@@ -0,0 +1,22 @@
+<!DOCTYPE HTML>
+<html lang="en-US" {% block htmlTag %}{% endblock %}>
+    {{ htmlSnippet("html:start")|default("") }}
+    <head>
+        {{ htmlSnippet("head:start")|default("") }}
+        <meta charset="UTF-8">
+        <title>{% block title %}{% endblock %}</title>
+        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+        <meta name="description" content="{% block description %}{% endblock %}">
+        <meta name="generator" content="GitBook {{ gitbook.version }}">
+        {% block head %}{% endblock %}
+        {{ htmlSnippet("head:end")|default("") }}
+    </head>
+    <body>
+        {{ htmlSnippet("body:start")|default("") }}
+        {% block style %}{% endblock %}
+        {% block content %}{% endblock %}
+        {% block javascript %}{% endblock %}
+        {{ htmlSnippet("body:end")|default("") }}
+    </body>
+    {{ htmlSnippet("html:end")|default("") }}
+</html>

theme/templates/ebook/page.html

@@ -1,4 +1,4 @@
-{% extends "layout.html" %}
+{% extends "./layout.html" %}
 
 {% block title %}{{ progress.current.title }} | {{ title }}{% endblock %}
 
@@ -17,20 +17,16 @@
 <div class="page">
     <h1 class="book-chapter book-chapter-{{ progress.current.level|lvl }}">{{ progress.current.title }}</h1>
     {% for section in content %}
-        <section class="{{ section.type }}" id="section-{{ section.id }}">
+        <div class="{{ section.type }}" id="section-{{ section.id }}">
         {% if section.type == "normal" %}
             {% autoescape false %}{{ section.content }}{% endautoescape %}
         {% elif section.type == "exercise" %}
-            {% include "./includes/page/exercise.html" with {section: section} %}
+            {% include "./includes/exercise.html" with {section: section} %}
         {% elif section.type == "quiz" %}
-            {% include "./includes/page/quiz.html" with {section: section} %}
+            {% include "./includes/quiz.html" with {section: section} %}
         {% endif %}
-        </section>
+        </div>
     {% endfor %}
-
-    {% if progress.current.next and progress.current.next.path %}
-    <a href="{{ basePath }}/{{ progress.current.next.path|mdLink }}" />
-    {% endif %}
 </div>
 {% endblock %}
 

theme/templates/ebook/summary.html

@@ -0,0 +1,50 @@
+{% extends "./layout.html" %}
+
+{% block title %}Table of Contents | {{ title }}{% endblock %}
+
+{% block style %}
+<link rel="stylesheet" href="{{ staticBase }}/print.css">
+{% for resource in plugins.resources.css %}
+    {% if resource.url %}
+    <link rel="stylesheet" href="{{ resource.url }}">
+    {% else %}
+    <link rel="stylesheet" href="{{ staticBase }}/plugins/{{ resource.path }}">
+    {% endif %}
+{% endfor %}
+{% endblock %}
+
+{% macro articles(_articles) %}
+    {% for item in _articles %}
+        {% set externalLink = item.path|isExternalLink %}
+        <li>
+            {% if item.path %}
+                {% if !externalLink %}
+                    <a href="{{ basePath }}/{{ item.path|mdLink }}">{{ item.title }}</a>
+                {% else %}
+                    <a target="_blank" href="{{ item.path }}">{{ item.title }}</a>
+                {% endif %}
+            {% else %}
+            {{ item.title }}
+            {% endif %}
+            {% if item.articles.length > 0 %}
+            <ol>
+                {{ articles(item.articles) }}
+            </ol>
+            {% endif %}
+        </li>
+    {% endfor %}
+{% endmacro %}
+
+{% block content %}
+<div class="page page-toc">
+    <h1>Table of Contents</h1>
+    <ol>
+    {{ articles(summary.chapters) }}
+
+    {% if glossary.length > 0 %}
+    <li><a href="{{ basePath }}/GLOSSARY.html">Glossary</a></li>
+    {% endif %}
+    </ol>
+</div>
+{% endblock %}
+

theme/templates/layout.html

@@ -4,6 +4,7 @@
     <head>
         {{ htmlSnippet("head:start")|default("") }}
         <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=11; IE=10; IE=9; IE=8; IE=7; IE=EDGE" />
         <title>{% block title %}{% endblock %}</title>
         <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
         <meta name="description" content="{% block description %}{% endblock %}">