Bump version to 2.6.2

Revert "Fix small font rendering issue on Macs"

.eslintignore

@@ -0,0 +1 @@
+theme/**/*

.eslintrc

@@ -0,0 +1,19 @@
+{
+    "rules": {
+        "indent": [ 2, 4 ],
+        "quotes": [ 2, "single" ],
+        "linebreak-style": [ 2, "unix" ],
+        "semi": [ 2, "always" ],
+        "no-unused-vars": [ 2, {
+            "vars": "all",
+            "args": "none"
+        } ],
+        "spaced-comment": [ 2, "always" ]
+    },
+    "env": {
+        "node": true,
+        "mocha": true,
+        "browser": true
+    },
+    "extends": "eslint:recommended"
+}

.gitignore

@@ -24,8 +24,5 @@ build/Release
 # see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
 
-theme/javascript/vendors
-theme/vendors
-
 # vim swapfile
 *.swp

.jshintrc

@@ -1,7 +0,0 @@
-{
-    "strict": false,
-    "browser": false,
-    "quotmark": true,
-    "node": true,
-    "mocha": true
-}

.travis.yml

@@ -1,7 +1,8 @@
 sudo: false
 language: node_js
 node_js:
-  - "0.11"
+  - "stable"
-  - "0.10"
+  - "4.1"
+  - "0.12"
 before_install:
-  - npm install svgexport -g
+  - npm install svgexport -g

AUTHORS.md

@@ -55,3 +55,9 @@ Translators
     - Hong Nguyen (@nghong)
 - Hebrew
     - @a-moses
+- Ukrainian
+    - @Karnaukhov
+- Czech
+    - @mjanda
+- Swedish
+    - Jacob Burenstam (@buren)

CHANGES.md

@@ -2,6 +2,54 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.6.2
+- Fix `gitbook.state.bookRoot`, `gitbook.state.root` now has a trailing slash
+- Update nunjucks to 2.2.0
+
+## 2.6.1
+- Use CamelCase for `gitbook.state.innerLanguage`
+
+## 2.6.0
+- Close sidebar after clicking a link on mobile
+- Add root for multilingual books: `gitbook.state.bookRoot`
+- Fix color of h6 headings
+- Fix bottom margin of lists and blockquotes
+- Add Swedish translation (`sv`)
+- Add Czech translation (`cs`)
+- Fix locale names for `zh-hans` and `jp`
+- Update plugin `search` to fix crashes
+- Aceept case-incensitive structure files (README, GLOSSARY, etc)
+
+## 2.5.2
+- Fix custom stylesheets for ebook generation
+- Trigger event `start` before `page.change`
+
+## 2.5.1
+- Fix calcul of `gitbook.state.root` when serving HTML index as `/`
+
+## 2.5.0
+- Font settings, sharing and search are externalized as default plugins
+- Plugins can define a configuration schema in the manifest, this schema will be used to validate configuration during build
+- New Node.js API for plugin: `book.formatString(type, content)`
+- New client side API for website plugins: `gitbook.toolbar.createButton(opts)`
+- Better header/footer for PDF, CSS wil be inlined to easily style the header/footer
+- Cleaner table of contents for ebooks
+- Support for RTL in ebook's table of contents
+- Better colors for mobi (links and code blocks)
+- Fix installation of plugins when using a pre-release
+- Fix support for pre-releases
+- Update asciidoc parser to remove git dependency
+- Fix templating in imported content
+- Fix querystring in image urls
+- Normalize heading IDs like GitHub
+- Use Arial as default font for PDFs
+- Add `root`, `chapterTitle` and `filepath` to `gitbook.state` JS API
+
+## 2.4.3
+- Add ukrainian translation (`uk`)
+- Add `book.json` configuration for maximum size of search index
+- Improve reliability of summary parser
+
 ## 2.4.2
 - Default plugins should not be installed by `gitbook install`
 - Limit search index size to avoid crash during generation

Gruntfile.js

@@ -1,96 +0,0 @@
-module.exports = function (grunt) {
-    var path = require("path");
-
-    // Load NPM tasks
-    grunt.loadNpmTasks('grunt-contrib-copy');
-    grunt.loadNpmTasks('grunt-contrib-less');
-    grunt.loadNpmTasks('grunt-contrib-requirejs');
-    grunt.loadNpmTasks("grunt-bower-install-simple");
-
-    // Init GRUNT configuraton
-    grunt.initConfig({
-        pkg: grunt.file.readJSON('package.json'),
-        'bower-install-simple': {
-            options: {
-                color:       true,
-                production:  false,
-                directory:   "theme/vendors"
-            }
-        },
-        less: {
-            development: {
-                options: {
-                    compress: true,
-                    yuicompress: true,
-                    optimization: 2
-                },
-                files: {
-                    "theme/assets/style.css": "theme/stylesheets/website.less",
-                    "theme/assets/print.css": "theme/stylesheets/ebook.less"
-                }
-            }
-        },
-        requirejs: {
-            compile: {
-                options: {
-                    name: "gitbook",
-                    baseUrl: "theme/javascript/",
-                    out: "theme/assets/app.js",
-                    preserveLicenseComments: false,
-                    optimize: "uglify",
-                    include: ["requireLib"],
-                    paths: {
-                        "jQuery": '../vendors/jquery/dist/jquery',
-                        "lodash": '../vendors/lodash/dist/lodash',
-                        "requireLib": '../vendors/requirejs/require',
-                        "Mousetrap": '../vendors/mousetrap/mousetrap',
-                        "lunr": '../vendors/lunr.js/lunr',
-                        "URIjs": '../vendors/URIjs/src/',
-                        "ace": '../vendors/ace-builds/src-noconflict/'
-                    },
-                    shim: {
-                        'jQuery': {
-                            exports: '$'
-                        },
-                        'lodash': {
-                            exports: '_'
-                        },
-                        'Mousetrap': {
-                            exports: 'Mousetrap'
-                        },
-                        'lunr': {
-                            exports: 'lunr'
-                        }
-                    }
-                }
-            }
-        },
-        copy: {
-            vendors: {
-                files: [
-                    {
-                        expand: true,
-                        cwd: 'theme/vendors/fontawesome/fonts/',
-                        src: ['**'],
-                        dest: 'theme/assets/fonts/fontawesome/',
-                        filter: 'isFile'
-                    }
-                ]
-            }
-        }
-    });
-
-    grunt.registerTask("bower-install", [ "bower-install-simple" ]);
-
-    // Build
-    grunt.registerTask('build', [
-        'bower-install',
-        'less',
-        'requirejs',
-        'copy:vendors'
-    ]);
-
-    grunt.registerTask('default', [
-        'build'
-    ]);
-};

README.md

@@ -4,12 +4,13 @@ GitBook
 [![NPM version](https://badge.fury.io/js/gitbook.svg)](http://badge.fury.io/js/gitbook)
 [![Linux Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
 [![Windows Build status](https://ci.appveyor.com/api/projects/status/63nlflxcwmb2pue6?svg=true)](https://ci.appveyor.com/project/GitBook/gitbook)
+[![Slack Status](https://slack.gitbook.com/badge.svg)](https://slack.gitbook.com)
 
 GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [Learn Javascript](https://www.gitbook.com/book/GitBookIO/javascript).
 
 You can publish and host book easily online using [gitbook.com](https://www.gitbook.com), a desktop editor is [also available](https://www.gitbook.com/editor).
 
-Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
+Check out the [GitBook Community Slack Channel](https://slack.gitbook.com), Stay updated by following [@GitBookIO](https://twitter.com/GitBookIO) on Twitter or [GitBook](https://www.facebook.com/gitbookcom) on Facebook.
 
 Complete documentation is available at [help.gitbook.com](http://help.gitbook.com/).
 
@@ -212,7 +213,7 @@ Plugins needed to build a book can be installed using: `gitbook install ./`. You
 You can use the options `--log=debug` and `--debug` to get better error messages (with stack trace). For example:
 
 ```
-$ gitbook build ./ -- log=debug --debug
+$ gitbook build ./ --log=debug --debug
 ```
 
 #### How to use the latest commit from GitBook in gitbook-cli
@@ -221,9 +222,9 @@ To use the latest commit from `GitBook/gitbook` with `gitbook-cli`:
 
 ```
 $ git clone https://github.com/GitbookIO/gitbook.git ./gitbook
-$ gitbook versions:link 2.0.0 ./gitbook
+$ gitbook versions:link ./gitbook
 ```
 
-Now the version tag `2.0.0` wil be associated with the `./gitbook` folder.
+Now `gitbook-cli` will be using the `./gitbook` folder.
 
-You can uninstall it using: `gitbook versions:uninstall 2.0.0`.
+You can uninstall it using: `gitbook versions:uninstall latest`.

appveyor.yml

@@ -5,8 +5,8 @@ init:
 # Test against these versions of Node.js.
 environment:
   matrix:
-    - nodejs_version: "0.10"
+    - nodejs_version: "0.12"
-    - nodejs_version: "0.11"
+    - nodejs_version: "4.1"
 
 # Install scripts. (runs after repo cloning)
 install:

bin/gitbook.js

@@ -2,6 +2,6 @@
 
 var color = require('bash-color');
 
-console.log(color.red("You need to install 'gitbook-cli' to have access to the gitbook command anywhere on your system."));
+console.log(color.red('You need to install "gitbook-cli" to have access to the gitbook command anywhere on your system.'));
-console.log(color.red("If you've installed this package globally, you need to uninstall it."));
+console.log(color.red('If you\'ve installed this package globally, you need to uninstall it.'));
-console.log(color.red(">> Run 'npm uninstall -g gitbook' then 'npm install -g gitbook-cli'"));
+console.log(color.red('>> Run "npm uninstall -g gitbook" then "npm install -g gitbook-cli"'));

bower.json

@@ -1,13 +0,0 @@
-{
-    "name": "GitBook",
-    "version": "1.0.0",
-    "dependencies": {
-        "jquery": "2.1.1",
-        "lodash": "2.4.1",
-        "requirejs": "2.1.11",
-        "URIjs": "1.13.1",
-        "mousetrap": "1.4.6",
-        "lunr.js": "0.5.2",
-        "fontawesome": "4.1.0"
-    }
-}

gulpfile.js

@@ -0,0 +1,47 @@
+var _ = require('lodash');
+var gulp = require('gulp');
+var gutil = require('gulp-util');
+var less = require('gulp-less');
+var rename = require('gulp-rename');
+var minifyCSS = require('gulp-minify-css');
+var browserify = require('browserify');
+var mergeStream = require('merge-stream');
+var source = require('vinyl-source-stream');
+
+gulp.task('css', function() {
+    var merged = mergeStream();
+
+    _.each({
+        'ebook.less': 'ebook/ebook.css',
+        'pdf.less': 'ebook/pdf.css',
+        'mobi.less': 'ebook/mobi.css',
+        'epub.less': 'ebook/epub.css',
+        'website.less': 'website/style.css'
+    }, function(out, input) {
+        gutil.log('compiling', input, 'into', out);
+        merged.add(gulp.src('theme/stylesheets/'+input)
+            .pipe(less())
+            .pipe(minifyCSS())
+            .pipe(rename(out))
+            .pipe(gulp.dest('theme/assets/')));
+    });
+
+    return merged;
+});
+
+gulp.task('js', function() {
+    return browserify('./theme/javascript/index.js')
+        .bundle()
+        .pipe(source('app.js'))
+        .pipe(gulp.dest('./theme/assets/website'));
+});
+
+gulp.task('assets', function() {
+    return gulp.src('./node_modules/font-awesome/fonts/*')
+    .pipe(gulp.dest('theme/assets/website/fonts/fontawesome/'));
+});
+
+gulp.task('default', ['css', 'js', 'assets'], function() {
+
+});
+

lib/book.js

@@ -1,25 +1,22 @@
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
-var path = require("path");
+var path = require('path');
-var lunr = require("lunr");
+var parsers = require('gitbook-parsers');
-var parsers = require("gitbook-parsers");
 
-var fs = require("./utils/fs");
+var fs = require('./utils/fs');
-var parseNavigation = require("./utils/navigation");
+var parseNavigation = require('./utils/navigation');
-var parseProgress = require("./utils/progress");
+var parseProgress = require('./utils/progress');
-var pageUtil = require("./utils/page");
+var pageUtil = require('./utils/page');
-var pathUtil = require("./utils/path");
+var pathUtil = require('./utils/path');
-var links = require("./utils/links");
+var links = require('./utils/links');
-var i18n = require("./utils/i18n");
+var i18n = require('./utils/i18n');
-var logger = require("./utils/logger");
+var logger = require('./utils/logger');
 
-var Configuration = require("./configuration");
+var Configuration = require('./configuration');
-var TemplateEngine = require("./template");
+var TemplateEngine = require('./template');
-var PluginsList = require("./pluginslist");
+var PluginsList = require('./pluginslist');
 
-var generators = require("./generators");
+var generators = require('./generators');
-
-var SEARCHINDEX_MAXSIZE = 1000000;
 
 var Book = function(root, context, parent) {
     this.context = _.defaults(context || {}, {
@@ -32,7 +29,7 @@ var Book = function(root, context, parent) {
         },
 
         // Log level
-        logLevel: "info"
+        logLevel: 'info'
     });
 
     // Log
@@ -46,7 +43,7 @@ var Book = function(root, context, parent) {
 
     // Configuration
     this.config = new Configuration(this, this.context.config);
-    Object.defineProperty(this, "options", {
+    Object.defineProperty(this, 'options', {
         get: function () {
             return this.config.options;
         }
@@ -80,23 +77,13 @@ var Book = function(root, context, parent) {
     this.readmeFile = null;
     this.langsFile = null;
 
-    // Search Index
-    this.searchIndexEnabled = true;
-    this.searchIndexSize = 0;
-    this.searchIndex = lunr(function () {
-        this.ref("url");
-
-        this.field("title", { boost: 10 });
-        this.field("body");
-    });
-
     // Bind methods
     _.bindAll(this);
 };
 
 // Return string representation
 Book.prototype.toString = function() {
-    return "[Book "+this.root+"]";
+    return '[Book '+this.root+']';
 };
 
 // Initialize and parse the book: config, summary, glossary
@@ -114,17 +101,17 @@ Book.prototype.parse = function() {
         return that.parseLangs()
         .then(function() {
             multilingual = that.langs.length > 0;
-            if (multilingual) that.log.info.ln("Parsing multilingual book, with", that.langs.length, "languages");
+            if (multilingual) that.log.info.ln('Parsing multilingual book, with', that.langs.length, 'languages');
 
             // Sub-books that inherit from the current book configuration
             that.books = _.map(that.langs, function(lang) {
-                that.log.info.ln("Preparing language book", lang.lang);
+                that.log.info.ln('Preparing language book', lang.lang);
                 return new Book(
                     path.join(that.root, lang.path),
                     _.merge({}, that.context, {
                         config: _.extend({}, that.options, {
-                            "output": path.join(that.options.output, lang.lang),
+                            'output': path.join(that.options.output, lang.lang),
-                            "language": lang.lang
+                            'language': lang.lang
                         })
                     }),
                     that
@@ -167,15 +154,15 @@ Book.prototype.generate = function(generator) {
     var that = this;
     that.options.generator = generator || that.options.generator;
 
-    that.log.info.ln("start generation with", that.options.generator, "generator");
+    that.log.info.ln('start generation with', that.options.generator, 'generator');
     return Q()
 
     // Clean output folder
     .then(function() {
-        that.log.info("clean", that.options.generator, "generator");
+        that.log.info('clean', that.options.generator, 'generator');
         return fs.clean(that.options.output)
         .progress(function(p) {
-            that.log.debug.ln("remove", p.file, "("+p.i+"/"+p.count+")");
+            that.log.debug.ln('remove', p.file, '('+p.i+'/'+p.count+')');
         })
         .then(function() {
             that.log.info.ok();
@@ -185,12 +172,20 @@ Book.prototype.generate = function(generator) {
     // Create generator
     .then(function() {
         var Generator = generators[generator];
-        if (!Generator) throw "Generator \""+that.options.generator+"\" doesn't exist";
+        if (!Generator) throw 'Generator \''+that.options.generator+'\' doesn\'t exist';
         generator = new Generator(that);
 
         return generator.prepare();
     })
 
+    // Transform configuration
+    .then(function() {
+        return that.callHook('config', that.config.dump())
+        .then(function(newConfig) {
+            that.config.replace(newConfig);
+        });
+    })
+
     // Generate content
     .then(function() {
         if (that.isMultilingual()) {
@@ -198,43 +193,43 @@ Book.prototype.generate = function(generator) {
         } else {
             // Separate list of files into the different operations needed
             var ops = _.groupBy(that.files, function(file) {
-                if (file[file.length -1] == "/") {
+                if (file[file.length -1] == '/') {
-                    return "directories";
+                    return 'directories';
                 } else if (_.contains(parsers.extensions, path.extname(file)) && that.navigation[file]) {
-                    return "content";
+                    return 'content';
                 } else {
-                    return "files";
+                    return 'files';
                 }
             });
 
 
             return Q()
 
-            // First, let"s create folder
+            // First, let's create folder
             .then(function() {
                 return _.reduce(ops.directories || [], function(prev, folder) {
                     return prev.then(function() {
-                        that.log.debug.ln("transferring folder", folder);
+                        that.log.debug.ln('transferring folder', folder);
                         return Q(generator.transferFolder(folder));
                     });
                 }, Q());
             })
 
-            // Then, let"s copy other files
+            // Then, let's copy other files
             .then(function() {
                 return Q.all(_.map(ops.files || [], function(file) {
-                    that.log.debug.ln("transferring file", file);
+                    that.log.debug.ln('transferring file', file);
                     return Q(generator.transferFile(file));
                 }));
             })
 
-            // Finally let"s generate content
+            // Finally let's generate content
             .then(function() {
                 var nFiles = (ops.content || []).length;
                 return _.reduce(ops.content || [], function(prev, file, i) {
                     return prev.then(function() {
-                        var p = ((i*100)/nFiles).toFixed(0)+"%";
+                        var p = ((i*100)/nFiles).toFixed(0)+'%';
-                        that.log.debug.ln("processing", file, p);
+                        that.log.debug.ln('processing', file, p);
 
                         return Q(generator.convertFile(file))
                         .fail(function(err) {
@@ -251,16 +246,16 @@ Book.prototype.generate = function(generator) {
 
     // Finish generation
     .then(function() {
-        return generator.callHook("finish:before");
+        return that.callHook('finish:before');
     })
     .then(function() {
         return generator.finish();
     })
     .then(function() {
-        return generator.callHook("finish");
+        return that.callHook('finish');
     })
     .then(function() {
-        that.log.info.ln("generation is finished");
+        that.log.info.ln('generation is finished');
     });
 };
 
@@ -286,7 +281,7 @@ Book.prototype.generateFile = function(output, options) {
     options = _.defaults(options || {}, {
         ebookFormat: path.extname(output).slice(1)
     });
-    output = output || path.resolve(book.root, "book."+options.ebookFormat);
+    output = output || path.resolve(book.root, 'book.'+options.ebookFormat);
 
     return fs.tmp.dir()
     .then(function(tmpDir) {
@@ -299,13 +294,13 @@ Book.prototype.generateFile = function(output, options) {
                 var _tmpDir = tmpDir;
 
                 if (lang) {
-                    _outputFile = _outputFile.slice(0, -path.extname(_outputFile).length)+"_"+lang+path.extname(_outputFile);
+                    _outputFile = _outputFile.slice(0, -path.extname(_outputFile).length)+'_'+lang+path.extname(_outputFile);
                     _tmpDir = path.join(_tmpDir, lang);
                 }
 
-                book.log.debug.ln("copy ebook to", _outputFile);
+                book.log.debug.ln('copy ebook to', _outputFile);
                 return fs.copy(
-                    path.join(_tmpDir, "index."+options.ebookFormat),
+                    path.join(_tmpDir, 'index.'+options.ebookFormat),
                     _outputFile
                 );
             };
@@ -325,7 +320,7 @@ Book.prototype.generateFile = function(output, options) {
                 }
             })
             .then(function(n) {
-                book.log.info.ok(n+" file(s) generated");
+                book.log.info.ok(n+' file(s) generated');
 
                 return fs.remove(tmpDir);
             });
@@ -337,7 +332,7 @@ Book.prototype.generateFile = function(output, options) {
 Book.prototype.parseConfig = function() {
     var that = this;
 
-    that.log.info("loading book configuration....");
+    that.log.info('loading book configuration....');
     return that.config.load()
     .then(function() {
         that.log.info.ok();
@@ -351,34 +346,34 @@ Book.prototype.parsePlugins = function() {
     // Load plugins
     return that.plugins.load(that.options.plugins)
     .then(function() {
-        if (_.size(that.plugins.failed) > 0) return Q.reject(new Error("Error loading plugins: "+that.plugins.failed.join(",")+". Run \"gitbook install\" to install plugins from NPM."));
+        if (_.size(that.plugins.failed) > 0) return Q.reject(new Error('Error loading plugins: '+that.plugins.failed.join(',')+'. Run \'gitbook install\' to install plugins from NPM.'));
 
-        that.log.info.ok(that.plugins.count()+" plugins loaded");
+        that.log.info.ok(that.plugins.count()+' plugins loaded');
-        that.log.debug.ln("normalize plugins list");
+        that.log.debug.ln('normalize plugins list');
     });
 };
 
 // Parse readme to extract defaults title and description
 Book.prototype.parseReadme = function() {
     var that = this;
-    var structure = that.config.getStructure("readme");
+    var filename = that.config.getStructure('readme', true);
-    that.log.debug.ln("start parsing readme:", structure);
+    that.log.debug.ln('start parsing readme:', filename);
 
-    return that.findFile(structure)
+    return that.findFile(filename)
     .then(function(readme) {
-        if (!readme) throw "No README file";
+        if (!readme) throw 'No README file';
-        if (!_.contains(that.files, readme.path)) throw "README file is ignored";
+        if (!_.contains(that.files, readme.path)) throw 'README file is ignored';
 
         that.readmeFile = readme.path;
         that._defaultsStructure(that.readmeFile);
 
-        that.log.debug.ln("readme located at", that.readmeFile);
+        that.log.debug.ln('readme located at', that.readmeFile);
         return that.template.renderFile(that.readmeFile)
         .then(function(content) {
             return readme.parser.readme(content)
             .fail(function(err) {
                 throw that.normError(err, {
-                    name: err.name || "Readme Parse Error",
+                    name: err.name || 'Readme Parse Error',
                     fileName: that.readmeFile
                 });
             });
@@ -395,23 +390,23 @@ Book.prototype.parseReadme = function() {
 Book.prototype.parseLangs = function() {
     var that = this;
 
-    var structure = that.config.getStructure("langs");
+    var filename = that.config.getStructure('langs', true);
-    that.log.debug.ln("start parsing languages index:", structure);
+    that.log.debug.ln('start parsing languages index:', filename);
 
-    return that.findFile(structure)
+    return that.findFile(filename)
     .then(function(langs) {
         if (!langs) return [];
 
         that.langsFile = langs.path;
         that._defaultsStructure(that.langsFile);
 
-        that.log.debug.ln("languages index located at", that.langsFile);
+        that.log.debug.ln('languages index located at', that.langsFile);
         return that.template.renderFile(that.langsFile)
         .then(function(content) {
             return langs.parser.langs(content)
             .fail(function(err) {
                 throw that.normError(err, {
-                    name: err.name || "Langs Parse Error",
+                    name: err.name || 'Langs Parse Error',
                     fileName: that.langsFile
                 });
             });
@@ -426,29 +421,29 @@ Book.prototype.parseLangs = function() {
 Book.prototype.parseSummary = function() {
     var that = this;
 
-    var structure = that.config.getStructure("summary");
+    var filename = that.config.getStructure('summary', true);
-    that.log.debug.ln("start parsing summary:", structure);
+    that.log.debug.ln('start parsing summary:', filename);
 
-    return that.findFile(structure)
+    return that.findFile(filename)
     .then(function(summary) {
-        if (!summary) throw "No SUMMARY file";
+        if (!summary) throw 'No SUMMARY file';
 
         // Remove the summary from the list of files to parse
         that.summaryFile = summary.path;
         that._defaultsStructure(that.summaryFile);
         that.files = _.without(that.files, that.summaryFile);
 
-        that.log.debug.ln("summary located at", that.summaryFile);
+        that.log.debug.ln('summary located at', that.summaryFile);
         return that.template.renderFile(that.summaryFile)
         .then(function(content) {
             return summary.parser.summary(content, {
                 entryPoint: that.readmeFile,
-                entryPointTitle: that.i18n("SUMMARY_INTRODUCTION"),
+                entryPointTitle: that.i18n('SUMMARY_INTRODUCTION'),
                 files: that.files
             })
             .fail(function(err) {
                 throw that.normError(err, {
-                    name: err.name || "Summary Parse Error",
+                    name: err.name || 'Summary Parse Error',
                     fileName: that.summaryFile
                 });
             });
@@ -464,10 +459,10 @@ Book.prototype.parseSummary = function() {
 Book.prototype.parseGlossary = function() {
     var that = this;
 
-    var structure = that.config.getStructure("glossary");
+    var filename = that.config.getStructure('glossary', true);
-    that.log.debug.ln("start parsing glossary: ", structure);
+    that.log.debug.ln('start parsing glossary: ', filename);
 
-    return that.findFile(structure)
+    return that.findFile(filename)
     .then(function(glossary) {
         if (!glossary) return [];
 
@@ -476,13 +471,13 @@ Book.prototype.parseGlossary = function() {
         that._defaultsStructure(that.glossaryFile);
         that.files = _.without(that.files, that.glossaryFile);
 
-        that.log.debug.ln("glossary located at", that.glossaryFile);
+        that.log.debug.ln('glossary located at', that.glossaryFile);
         return that.template.renderFile(that.glossaryFile)
         .then(function(content) {
             return glossary.parser.glossary(content)
             .fail(function(err) {
                 throw that.normError(err, {
-                    name: err.name || "Glossary Parse Error",
+                    name: err.name || 'Glossary Parse Error',
                     fileName: that.glossaryFile
                 });
             });
@@ -514,12 +509,12 @@ Book.prototype.parsePage = function(filename, options) {
         });
     };
 
-    that.log.debug.ln("start parsing file", filename);
+    that.log.debug.ln('start parsing file', filename);
 
     var extension = path.extname(filename);
     var filetype = parsers.get(extension);
 
-    if (!filetype) return Q.reject(new Error("Can't parse file: "+filename));
+    if (!filetype) return Q.reject(new Error('Can\'t parse file: '+filename));
 
     // Type of parser used
     page.type = filetype.name;
@@ -533,7 +528,7 @@ Book.prototype.parsePage = function(filename, options) {
     // Progress in the book
     page.progress = parseProgress(that.navigation, filename);
 
-    that.log.debug.ln("render template", filename);
+    that.log.debug.ln('render template', filename);
 
     // Read file content
     return that.readFile(page.path)
@@ -560,7 +555,7 @@ Book.prototype.parsePage = function(filename, options) {
     .then(function(content) {
         page.content = content;
 
-        that.log.debug.ln("use file parser", filetype.name, "for", filename);
+        that.log.debug.ln('use file parser', filetype.name, 'for', filename);
         return filetype.page(page.content);
     })
 
@@ -568,7 +563,7 @@ Book.prototype.parsePage = function(filename, options) {
     .then(function(_page) {
         return _.reduce(_page.sections, function(prev, section) {
             return prev.then(function(_sections) {
-                return that.template.postProcess(section.content || "")
+                return that.template.postProcess(section.content || '')
                 .then(function(content) {
                     section.content = content;
                     return _sections.concat([section]);
@@ -584,8 +579,8 @@ Book.prototype.parsePage = function(filename, options) {
             convertImages: options.convertImages,
             input: filename,
             navigation: that.navigation,
-            base: path.dirname(filename) || "./",
+            base: path.dirname(filename) || './',
-            output: path.dirname(filename) || "./",
+            output: path.dirname(filename) || './',
             glossary: that.glossary
         });
     })
@@ -597,7 +592,6 @@ Book.prototype.parsePage = function(filename, options) {
     })
 
     .then(function() {
-        that.indexPage(page);
         return page;
     });
 };
@@ -606,25 +600,51 @@ Book.prototype.parsePage = function(filename, options) {
 Book.prototype.findFile = function(filename) {
     var that = this;
 
-    return _.reduce(parsers.extensions, function(prev, ext) {
+    var ext = path.extname(filename);
+    var basename = path.basename(filename, ext);
+
+    // Ordered list of extensions to test
+    var exts = parsers.extensions;
+    if (ext) exts = _.uniq([ext].concat(exts));
+
+    return _.reduce(exts, function(prev, ext) {
         return prev.then(function(output) {
             // Stop if already find a parser
             if (output) return output;
 
-            var filepath = filename+ext;
+            var filepath = basename+ext;
+
+            return fs.findFile(that.root, filepath)
+            .then(function(realFilepath) {
+                if (!realFilepath) return null;
 
-            return that.fileExists(filepath)
-            .then(function(exists) {
-                if (!exists) return null;
                 return {
                     parser: parsers.get(ext),
-                    path: filepath
+                    path: realFilepath
                 };
             });
         });
     }, Q(null));
 };
 
+// Format a string using a specific markup language
+Book.prototype.formatString = function(extension, content) {
+    return Q()
+    .then(function() {
+        var filetype = parsers.get(extension);
+        if (!filetype) throw new Error('Filetype doesn\'t exist: '+filetype);
+
+        return filetype.page(content);
+    })
+
+    // Merge sections
+    .then(function(page) {
+        return _.reduce(page.sections, function(content, section) {
+            return content + section.content;
+        }, '');
+    });
+};
+
 // Check if a file exists in the book
 Book.prototype.fileExists = function(filename) {
     return fs.exists(
@@ -641,7 +661,7 @@ Book.prototype.fileIsInBook = function(filename) {
 Book.prototype.readFile = function(filename) {
     return fs.readFile(
         this.resolve(filename),
-        { encoding: "utf8" }
+        { encoding: 'utf8' }
     );
 };
 
@@ -655,28 +675,28 @@ Book.prototype.listAllFiles = function() {
     var that = this;
 
     return fs.list(this.root, {
-        ignoreFiles: [".ignore", ".gitignore", ".bookignore"],
+        ignoreFiles: ['.ignore', '.gitignore', '.bookignore'],
         ignoreRules: [
             // Skip Git stuff
-            ".git/",
+            '.git/',
-            ".gitignore",
+            '.gitignore',
 
             // Skip OS X meta data
-            ".DS_Store",
+            '.DS_Store',
 
             // Skip stuff installed by plugins
-            "node_modules",
+            'node_modules',
 
             // Skip book outputs
-            "_book",
+            '_book',
-            "*.pdf",
+            '*.pdf',
-            "*.epub",
+            '*.epub',
-            "*.mobi",
+            '*.mobi',
 
             // Skip config files
-            ".ignore",
+            '.ignore',
-            ".bookignore",
+            '.bookignore',
-            "book.json",
+            'book.json',
         ]
     })
     .then(function(_files) {
@@ -695,7 +715,7 @@ Book.prototype.parentRoot = function() {
     return this.root;
 };
 
-// Return true if it"s a sub-book
+// Return true if it's a sub-book
 Book.prototype.isSubBook = function() {
     return !!this.parent;
 };
@@ -724,13 +744,13 @@ Book.prototype.relative = function(p) {
 // Normalize a path to .html and convert README -> index
 Book.prototype.contentPath = function(link) {
     if (
-        path.basename(link, path.extname(link)) == "README" ||
+        path.basename(link, path.extname(link)) == 'README' ||
         link == this.readmeFile
     ) {
-        link = path.join(path.dirname(link), "index"+path.extname(link));
+        link = path.join(path.dirname(link), 'index'+path.extname(link));
     }
 
-    link = links.changeExtension(link, ".html");
+    link = links.changeExtension(link, '.html');
     return link;
 };
 
@@ -739,40 +759,15 @@ Book.prototype.contentLink = function(link) {
     return links.normalize(this.contentPath(link));
 };
 
-// Index a page into the search index
-Book.prototype.indexPage = function(page) {
-    var nav = this.navigation[page.path];
-    if (!nav || !this.searchIndexEnabled) return;
-
-    this.log.debug.ln("index page", page.path);
-
-    // Extract text from the page
-    var text = pageUtil.extractText(page.sections);
-
-    // Limit size of index (to avoid #941)
-    this.searchIndexSize = this.searchIndexSize + text.length;
-    if (this.searchIndexSize > SEARCHINDEX_MAXSIZE) {
-        this.log.warn.ln("search index is too big, indexing is now disabled");
-        this.searchIndexEnabled = false;
-        return;
-    }
-
-    this.searchIndex.add({
-        url: this.contentLink(page.path),
-        title: nav.title,
-        body: text
-    });
-};
-
 // Default structure paths to an extension
 Book.prototype._defaultsStructure = function(filename) {
     var that = this;
     var extension = path.extname(filename);
 
-    that.readmeFile = that.readmeFile || that.config.getStructure("readme")+extension;
+    that.readmeFile = that.readmeFile || that.config.getStructure('readme')+extension;
-    that.summaryFile = that.summaryFile || that.config.getStructure("summary")+extension;
+    that.summaryFile = that.summaryFile || that.config.getStructure('summary')+extension;
-    that.glossaryFile = that.glossaryFile || that.config.getStructure("glossary")+extension;
+    that.glossaryFile = that.glossaryFile || that.config.getStructure('glossary')+extension;
-    that.langsFile = that.langsFile || that.config.getStructure("langs")+extension;
+    that.langsFile = that.langsFile || that.config.getStructure('langs')+extension;
 };
 
 // Change output path
@@ -805,87 +800,18 @@ Book.prototype.normError = function(err, opts, defs) {
     err.toString = function() {
         var attributes = [];
 
-        if (this.fileName) attributes.push("In file \""+this.fileName+"\"");
+        if (this.fileName) attributes.push('In file \''+this.fileName+'\'');
-        if (this.lineNumber) attributes.push("Line "+this.lineNumber);
+        if (this.lineNumber) attributes.push('Line '+this.lineNumber);
-        if (this.columnNumber) attributes.push("Column "+this.columnNumber);
+        if (this.columnNumber) attributes.push('Column '+this.columnNumber);
-        return (this.name || "Error")+": "+this.message+((attributes.length > 0)? " ("+attributes.join(", ")+")" : "");
+        return (this.name || 'Error')+': '+this.message+((attributes.length > 0)? ' ('+attributes.join(', ')+')' : '');
     };
 
     return err;
 };
 
-// Init and return a book
+// Call a hook in plugins
-Book.init = function(root, opts) {
+Book.prototype.callHook = function(name, data) {
-    var book = new Book(root, opts);
+    return this.plugins.hook(name, data);
-    var extensionToUse = ".md";
-
-    var chaptersPaths = function(chapters) {
-        return _.reduce(chapters || [], function(accu, chapter) {
-            var o = {
-                title: chapter.title
-            };
-            if (chapter.path) o.path = chapter.path;
-
-            return accu.concat(
-                [o].concat(chaptersPaths(chapter.articles))
-            );
-        }, []);
-    };
-
-    book.log.info.ln("init book at", root);
-    return fs.mkdirp(root)
-    .then(function() {
-        book.log.info.ln("detect structure from SUMMARY (if it exists)");
-        return book.parseSummary();
-    })
-    .fail(function() {
-        return Q();
-    })
-    .then(function() {
-        var summary = book.summaryFile || "SUMMARY.md";
-        var chapters = book.summary.chapters || [];
-        extensionToUse = path.extname(summary);
-
-        if (chapters.length === 0) {
-            chapters = [
-                {
-                    title: "Summary",
-                    path: "SUMMARY"+extensionToUse
-                },
-                {
-                    title: "Introduction",
-                    path: "README"+extensionToUse
-                }
-            ];
-        }
-
-        return Q(chaptersPaths(chapters));
-    })
-    .then(function(chapters) {
-        // Create files that don"t exist
-        return Q.all(_.map(chapters, function(chapter) {
-            if (!chapter.path) return Q();
-            var absolutePath = path.resolve(book.root, chapter.path);
-
-            return fs.exists(absolutePath)
-            .then(function(exists) {
-                if(exists) {
-                    book.log.info.ln("found", chapter.path);
-                    return;
-                } else {
-                    book.log.info.ln("create", chapter.path);
-                }
-
-                return fs.mkdirp(path.dirname(absolutePath))
-                .then(function() {
-                    return fs.writeFile(absolutePath, "# "+chapter.title+"\n");
-                });
-            });
-        }));
-    })
-    .then(function() {
-        book.log.info.ln("initialization is finished");
-    });
 };
 
 module.exports= Book;

lib/config_default.js

@@ -0,0 +1,109 @@
+var path = require('path');
+
+module.exports = {
+    // Options that can't be extend
+    'configFile': 'book',
+    'generator': 'website',
+    'extension': null,
+
+    // Book metadats (somes are extracted from the README by default)
+    'title': null,
+    'description': null,
+    'isbn': null,
+    'language': 'en',
+    'direction': null,
+    'author': null,
+
+    // version of gitbook to use
+    'gitbook': '*',
+
+    // Structure
+    'structure': {
+        'langs': 'LANGS.md',
+        'readme': 'README.md',
+        'glossary': 'GLOSSARY.md',
+        'summary': 'SUMMARY.md'
+    },
+
+    // CSS Styles
+    'styles': {
+        'website': 'styles/website.css',
+        'print': 'styles/print.css',
+        'ebook': 'styles/ebook.css',
+        'pdf': 'styles/pdf.css',
+        'mobi': 'styles/mobi.css',
+        'epub': 'styles/epub.css'
+    },
+
+    // Plugins list, can contain '-name' for removing default plugins
+    'plugins': [],
+
+    // Global configuration for plugins
+    'pluginsConfig': {},
+
+    // 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 for the file content
+        'fontSize': 12,
+        'fontFamily': 'Arial',
+
+        // 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',
+
+        // How to mark detected chapters.
+        // Choices are “pagebreak”, “rule”, 'both' or “none”.
+        'chapterMark' : 'pagebreak',
+
+        // An XPath expression. Page breaks are inserted before the specified elements.
+        // To disable use the expression: '/'
+        'pageBreaksBefore': '/',
+
+        // Margin (in pts)
+        // Note: 72 pts equals 1 inch
+        'margin': {
+            'right': 62,
+            'left': 62,
+            'top': 56,
+            'bottom': 56
+        },
+
+        // Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
+        'headerTemplate': null,
+
+        // Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
+        'footerTemplate': null
+    }
+};

lib/configuration.js

@@ -1,13 +1,16 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var Q = require("q");
+var Q = require('q');
-var path = require("path");
+var path = require('path');
-var semver = require("semver");
+var semver = require('semver');
 
-var pkg = require("../package.json");
+var pkg = require('../package.json');
-var i18n = require("./utils/i18n");
+var i18n = require('./utils/i18n');
+var version = require('./version');
+
+var DEFAULT_CONFIG = require('./config_default');
 
 // Default plugins added to each books
-var DEFAULT_PLUGINS = ["highlight"];
+var DEFAULT_PLUGINS = ['highlight', 'search', 'sharing', 'fontsettings'];
 
 // Check if a plugin is a default plugin
 // Plugin should be in the list
@@ -26,29 +29,29 @@ function isDefaultPlugin(name, version) {
 // Normalize a list of plugins to use
 function normalizePluginsList(plugins, addDefaults) {
     // Normalize list to an array
-    plugins = _.isString(plugins) ? plugins.split(",") : (plugins || []);
+    plugins = _.isString(plugins) ? plugins.split(',') : (plugins || []);
 
     // Remove empty parts
     plugins = _.compact(plugins);
 
-    // Divide as {name, version} to handle format like "myplugin@1.0.0"
+    // Divide as {name, version} to handle format like 'myplugin@1.0.0'
     plugins = _.map(plugins, function(plugin) {
         if (plugin.name) return plugin;
 
-        var parts = plugin.split("@");
+        var parts = plugin.split('@');
         var name = parts[0];
         var version = parts[1];
         return {
-            "name": name,
+            'name': name,
-            "version": version, // optional
+            'version': version, // optional
-            "isDefault": isDefaultPlugin(name, version)
+            'isDefault': isDefaultPlugin(name, version)
         };
     });
 
     // List plugins to remove
     var toremove = _.chain(plugins)
     .filter(function(plugin) {
-        return plugin.name.length > 0 && plugin.name[0] == "-";
+        return plugin.name.length > 0 && plugin.name[0] == '-';
     })
     .map(function(plugin) {
         return plugin.name.slice(1);
@@ -63,15 +66,15 @@ function normalizePluginsList(plugins, addDefaults) {
             }
 
             plugins.push({
-                "name": plugin,
+                'name': plugin,
-                "isDefault": true
+                'isDefault': true
             });
         });
     }
 
     // Remove plugin that start with '-'
     plugins = _.filter(plugins, function(plugin) {
-        return !_.contains(toremove, plugin.name) && !(plugin.name.length > 0 && plugin.name[0] == "-");
+        return !_.contains(toremove, plugin.name) && !(plugin.name.length > 0 && plugin.name[0] == '-');
     });
 
     // Remove duplicates
@@ -81,33 +84,8 @@ function normalizePluginsList(plugins, addDefaults) {
 }
 
 var Configuration = function(book, options) {
-    var that = this;
-
     this.book = book;
-
+    this.replace(options);
-    this.options = _.cloneDeep(Configuration.DEFAULT);
-    this.options = _.merge(this.options, options || {});
-
-    // options.input == book.root
-    Object.defineProperty(this.options, "input", {
-        get: function () {
-            return that.book.root;
-        }
-    });
-
-    // options.originalInput == book.parent.root
-    Object.defineProperty(this.options, "originalInput", {
-        get: function () {
-            return that.book.parent? that.book.parent.root : undefined;
-        }
-    });
-
-    // options.originalOutput == book.parent.options.output
-    Object.defineProperty(this.options, "originalOutput", {
-        get: function () {
-            return that.book.parent? that.book.parent.options.output : undefined;
-        }
-    });
 };
 
 // Read and parse the configuration
@@ -129,7 +107,7 @@ Configuration.prototype.load = function() {
             _config = require(configPath);
             that.options = _.merge(
                 that.options,
-                _.omit(_config, "configFile", "defaultsPlugins", "generator", "extension")
+                _.omit(_config, 'configFile', 'defaultsPlugins', 'generator', 'extension')
             );
         }
         catch(err) {
@@ -139,19 +117,19 @@ Configuration.prototype.load = function() {
     })
     .then(function() {
         if (!that.book.isSubBook()) {
-            if (!semver.satisfies(pkg.version, that.options.gitbook)) {
+            if (!version.satisfies(that.options.gitbook)) {
-                throw new Error("GitBook version doesn't satisfy version required by the book: "+that.options.gitbook);
+                throw new Error('GitBook version doesn\'t satisfy version required by the book: '+that.options.gitbook);
             }
-            if (that.options.gitbook != "*" && !semver.satisfies(semver.inc(pkg.version, "patch"), that.options.gitbook)) {
+            if (that.options.gitbook != '*' && !semver.satisfies(semver.inc(pkg.version, 'patch'), that.options.gitbook)) {
-                that.book.log.warn.ln("gitbook version specified in your book.json might be too strict for future patches, \""+(_.first(pkg.version.split("."))+".x.x")+"\" is more adequate");
+                that.book.log.warn.ln('gitbook version specified in your book.json might be too strict for future patches, \''+(_.first(pkg.version.split('.'))+'.x.x')+'\' is more adequate');
             }
         }
 
-        that.options.output = path.resolve(that.options.output || that.book.resolve("_book"));
+        that.options.output = path.resolve(that.options.output || that.book.resolve('_book'));
         that.options.plugins = normalizePluginsList(that.options.plugins);
-        that.options.defaultsPlugins = normalizePluginsList(that.options.defaultsPlugins || "", false);
+        that.options.defaultsPlugins = normalizePluginsList(that.options.defaultsPlugins || '', false);
         that.options.plugins = _.union(that.options.plugins, that.options.defaultsPlugins);
-        that.options.plugins = _.uniq(that.options.plugins, "name");
+        that.options.plugins = _.uniq(that.options.plugins, 'name');
 
         // Default value for text direction (from language)
         if (!that.options.direction) {
@@ -168,9 +146,47 @@ Configuration.prototype.extend = function(options) {
     _.extend(this.options, options);
 };
 
+// Replace the whole configuration
+Configuration.prototype.replace = function(options) {
+    var that = this;
+
+    this.options = _.cloneDeep(DEFAULT_CONFIG);
+    this.options = _.merge(this.options, options || {});
+
+    // options.input == book.root
+    Object.defineProperty(this.options, 'input', {
+        get: function () {
+            return that.book.root;
+        }
+    });
+
+    // options.originalInput == book.parent.root
+    Object.defineProperty(this.options, 'originalInput', {
+        get: function () {
+            return that.book.parent? that.book.parent.root : undefined;
+        }
+    });
+
+    // options.originalOutput == book.parent.options.output
+    Object.defineProperty(this.options, 'originalOutput', {
+        get: function () {
+            return that.book.parent? that.book.parent.options.output : undefined;
+        }
+    });
+};
+
+// Dump configuration as json object
+Configuration.prototype.dump = function() {
+    return _.cloneDeep(this.options);
+};
+
 // Get structure file
-Configuration.prototype.getStructure = function(name) {
+Configuration.prototype.getStructure = function(name, dontStripExt) {
-    return this.options.structure[name].split(".").slice(0, -1).join(".");
+    var filename = this.options.structure[name];
+    if (dontStripExt) return filename;
+
+    filename = filename.split('.').slice(0, -1).join('.');
+    return filename;
 };
 
 // Return normalized language
@@ -183,118 +199,12 @@ Configuration.prototype.get = function(key, def) {
     return _.get(this.options, key, def);
 };
 
-// Default configuration
+// Update a configuration
-Configuration.DEFAULT = {
+Configuration.prototype.set = function(key, value) {
-    // Options that can"t be extend
+    return _.set(this.options, key, value);
-    "configFile": "book",
-    "generator": "website",
-    "extension": null,
-
-    // Book metadats (somes are extracted from the README by default)
-    "title": null,
-    "description": null,
-    "isbn": null,
-    "language": "en",
-    "direction": null,
-    "author": null,
-
-    // version of gitbook to use
-    "gitbook": "*",
-
-    // Structure
-    "structure": {
-        "langs": "LANGS.md",
-        "readme": "README.md",
-        "glossary": "GLOSSARY.md",
-        "summary": "SUMMARY.md"
-    },
-
-    // CSS Styles
-    "styles": {
-        "website": "styles/website.css",
-        "print": "styles/print.css",
-        "ebook": "styles/ebook.css",
-        "pdf": "styles/pdf.css",
-        "mobi": "styles/mobi.css",
-        "epub": "styles/epub.css"
-    },
-
-    // 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",
-
-        // How to mark detected chapters.
-        // Choices are “pagebreak”, “rule”, "both" or “none”.
-        "chapterMark" : "pagebreak",
-
-        // An XPath expression. Page breaks are inserted before the specified elements.
-        // To disable use the expression: "/"
-        "pageBreaksBefore": "/",
-
-        // Margin (in pts)
-        // Note: 72 pts equals 1 inch
-        "margin": {
-            "right": 62,
-            "left": 62,
-            "top": 56,
-            "bottom": 56
-        },
-
-        //Header HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "headerTemplate": "",
-
-        //Footer HTML template. Available variables: _PAGENUM_, _TITLE_, _AUTHOR_ and _SECTION_.
-        "footerTemplate": ""
-    }
 };
 
+// Default configuration
+Configuration.DEFAULT = DEFAULT_CONFIG;
+
 module.exports= Configuration;

lib/conrefs_loader.js

@@ -1,15 +1,19 @@
-var path = require("path");
+var _ = require('lodash');
-var nunjucks = require("nunjucks");
+var path = require('path');
+var nunjucks = require('nunjucks');
 
-var git = require("./utils/git");
+var git = require('./utils/git');
-var fs = require("./utils/fs");
+var fs = require('./utils/fs');
-var pathUtil = require("./utils/path");
+var pathUtil = require('./utils/path');
 
 // The loader should handle relative and git url
 var BookLoader = nunjucks.Loader.extend({
     async: true,
 
-    init: function(book) {
+    init: function(book, opts) {
+        this.opts = _.defaults(opts || {}, {
+            interpolate: _.identity
+        });
         this.book = book;
     },
 
@@ -20,14 +24,20 @@ var BookLoader = nunjucks.Loader.extend({
         .then(function(filepath) {
             // Is local file
             if (!filepath) filepath = path.resolve(fileurl);
-            else that.book.log.debug.ln("resolve from git", fileurl, "to", filepath);
+            else that.book.log.debug.ln('resolve from git', fileurl, 'to', filepath);
 
             //  Read file from absolute path
             return fs.readFile(filepath)
+            .then(function(source) {
+                return that.opts.interpolate(filepath, source.toString());
+            })
             .then(function(source) {
                 return {
-                    src: source.toString(),
+                    src: source,
-                    path: filepath
+                    path: filepath,
+
+                    // We disable cache sincde content is modified (shortcuts, ...)
+                    noCache: true
                 };
             });
         })
@@ -53,7 +63,7 @@ var BookLoader = nunjucks.Loader.extend({
         return path.resolve(path.dirname(from), to);
     },
 
-    // Handle all files as relative, so that nunjucks pass responsability to "resolve"
+    // Handle all files as relative, so that nunjucks pass responsability to 'resolve'
     // Only git urls are considered as absolute
     isRelative: function(filename) {
         return !git.checkUrl(filename);

lib/generator.js

@@ -1,12 +1,12 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var path = require("path");
+var path = require('path');
-var Q = require("q");
+var Q = require('q');
-var fs = require("./utils/fs");
+var fs = require('./utils/fs');
 
 var BaseGenerator = function(book) {
     this.book = book;
 
-    Object.defineProperty(this, "options", {
+    Object.defineProperty(this, 'options', {
         get: function () {
             return this.book.options;
         }
@@ -16,19 +16,19 @@ var BaseGenerator = function(book) {
 };
 
 BaseGenerator.prototype.callHook = function(name, data) {
-    return this.book.plugins.hook(name, data);
+    return this.book.callHook(name, data);
 };
 
 // Prepare the genertor
 BaseGenerator.prototype.prepare = function() {
     var that = this;
 
-    return that.callHook("init");
+    return that.callHook('init');
 };
 
 // Write a parsed file to the output
 BaseGenerator.prototype.convertFile = function(input) {
-    return Q.reject(new Error("Could not convert "+input));
+    return Q.reject(new Error('Could not convert '+input));
 };
 
 // Copy file to the output (non parsable)
@@ -51,16 +51,16 @@ BaseGenerator.prototype.copyCover = function() {
     var that = this;
 
     return Q.all([
-        fs.copy(that.book.resolve("cover.jpg"), path.join(that.options.output, "cover.jpg")),
+        fs.copy(that.book.resolve('cover.jpg'), path.join(that.options.output, 'cover.jpg')),
-        fs.copy(that.book.resolve("cover_small.jpg"), path.join(that.options.output, "cover_small.jpg"))
+        fs.copy(that.book.resolve('cover_small.jpg'), path.join(that.options.output, 'cover_small.jpg'))
     ])
     .fail(function() {
         // If orignaly from multi-lang, try copy from parent
         if (!that.book.isSubBook()) return;
 
         return Q.all([
-            fs.copy(path.join(that.book.parentRoot(), "cover.jpg"), path.join(that.options.output, "cover.jpg")),
+            fs.copy(path.join(that.book.parentRoot(), 'cover.jpg'), path.join(that.options.output, 'cover.jpg')),
-            fs.copy(path.join(that.book.parentRoot(), "cover_small.jpg"), path.join(that.options.output, "cover_small.jpg"))
+            fs.copy(path.join(that.book.parentRoot(), 'cover_small.jpg'), path.join(that.options.output, 'cover_small.jpg'))
         ]);
     })
     .fail(function() {
@@ -70,7 +70,7 @@ BaseGenerator.prototype.copyCover = function() {
 
 // At teh end of the generation
 BaseGenerator.prototype.finish = function() {
-    return Q.reject(new Error("Could not finish generation"));
+    return Q.reject(new Error('Could not finish generation'));
 };
 
 module.exports = BaseGenerator;

lib/generators/ebook.js

@@ -1,12 +1,13 @@
-var util = require("util");
+var util = require('util');
-var path = require("path");
+var path = require('path');
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
-var exec = require("child_process").exec;
+var juice = require('juice');
+var exec = require('child_process').exec;
 
-var fs = require("../utils/fs");
+var fs = require('../utils/fs');
-var stringUtils = require("../utils/string");
+var stringUtils = require('../utils/string');
-var BaseGenerator = require("./website");
+var BaseGenerator = require('./website');
 
 var Generator = function(book, format) {
     BaseGenerator.apply(this, arguments);
@@ -15,10 +16,10 @@ var Generator = function(book, format) {
     this.ebookFormat = format;
 
     // Resources namespace
-    this.namespace = "ebook";
+    this.namespace = 'ebook';
 
     // Styles to use
-    this.styles = _.compact(["print", "ebook", this.ebookFormat]);
+    this.styles = _.compact(['print', 'ebook', this.ebookFormat]);
 
     // Convert images (svg -> png)
     this.convertImages = true;
@@ -26,9 +27,9 @@ var Generator = function(book, format) {
 util.inherits(Generator, BaseGenerator);
 
 Generator.prototype.prepareTemplates = function() {
-    this.templates.page = this.book.plugins.template("ebook:page") || path.resolve(this.options.theme, "templates/ebook/page.html");
+    this.templates.page = this.book.plugins.template('ebook:page') || path.resolve(this.options.theme, 'templates/ebook/page.html');
-    this.templates.summary = this.book.plugins.template("ebook:summary") || path.resolve(this.options.theme, "templates/ebook/summary.html");
+    this.templates.summary = this.book.plugins.template('ebook:summary') || path.resolve(this.options.theme, 'templates/ebook/summary.html');
-    this.templates.glossary = this.book.plugins.template("ebook:glossary") || path.resolve(this.options.theme, "templates/ebook/glossary.html");
+    this.templates.glossary = this.book.plugins.template('ebook:glossary') || path.resolve(this.options.theme, 'templates/ebook/glossary.html');
 
     return Q();
 };
@@ -37,8 +38,39 @@ Generator.prototype.prepareTemplates = function() {
 Generator.prototype.writeSummary = function() {
     var that = this;
 
-    that.book.log.info.ln("write SUMMARY.html");
+    that.book.log.info.ln('write SUMMARY.html');
-    return this._writeTemplate(this.templates.summary, {}, path.join(this.options.output, "SUMMARY.html"));
+    return this._writeTemplate(this.templates.summary, {}, path.join(this.options.output, 'SUMMARY.html'));
+};
+
+// Return template for footer/header with inlined css
+Generator.prototype.getPDFTemplate = function(id) {
+    var tpl = this.options.pdf[id+'Template'];
+    var defaultTpl = path.resolve(this.options.theme, 'templates/ebook/'+id+'.html');
+    var defaultCSS = path.resolve(this.options.theme, 'assets/ebook/pdf.css');
+
+    // Default template from theme
+    if (!tpl && fs.existsSync(defaultTpl)) {
+        tpl = fs.readFileSync(defaultTpl, { encoding: 'utf-8' });
+    }
+
+    // Inline CSS using juice
+    var stylesheets = [];
+
+    // From theme
+    if (fs.existsSync(defaultCSS)) {
+        stylesheets.push(fs.readFileSync(defaultCSS, { encoding: 'utf-8' }));
+    }
+
+    // Custom PDF style
+    if (this.styles.pdf) {
+        stylesheets.push(fs.readFileSync(this.book.resolve(this.styles.pdf), { encoding: 'utf-8' }));
+    }
+
+    tpl = juice(tpl, {
+        extraCss: stylesheets.join('\n\n')
+    });
+
+    return tpl;
 };
 
 Generator.prototype.finish = function() {
@@ -52,70 +84,71 @@ Generator.prototype.finish = function() {
     .then(function() {
         if (!that.ebookFormat) return Q();
 
-        if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
+        if (!that.options.cover && fs.existsSync(path.join(that.options.output, 'cover.jpg'))) {
-            that.options.cover = path.join(that.options.output, "cover.jpg");
+            that.options.cover = path.join(that.options.output, 'cover.jpg');
         }
 
         var d = Q.defer();
 
         var _options = {
-            "--cover": that.options.cover,
+            '--cover': that.options.cover,
-            "--title": that.options.title,
+            '--title': that.options.title,
-            "--comments": that.options.description,
+            '--comments': that.options.description,
-            "--isbn": that.options.isbn,
+            '--isbn': that.options.isbn,
-            "--authors": that.options.author,
+            '--authors': that.options.author,
-            "--language": that.options.language,
+            '--language': that.options.language,
-            "--book-producer": "GitBook",
+            '--book-producer': 'GitBook',
-            "--publisher": "GitBook",
+            '--publisher': 'GitBook',
-            "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
+            '--chapter': 'descendant-or-self::*[contains(concat(\' \', normalize-space(@class), \' \'), \' book-chapter \')]',
-            "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
+            '--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 ')]",
+            '--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 ')]",
+            '--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": "1",
+            '--max-levels': '1',
-            "--breadth-first": true
+            '--breadth-first': true
         };
 
-        if (that.ebookFormat == "pdf") {
+        if (that.ebookFormat == 'pdf') {
             var pdfOptions = that.options.pdf;
 
             _.extend(_options, {
-                "--chapter-mark": String(pdfOptions.chapterMark),
+                '--chapter-mark': String(pdfOptions.chapterMark),
-                "--page-breaks-before": String(pdfOptions.pageBreaksBefore),
+                '--page-breaks-before': String(pdfOptions.pageBreaksBefore),
-                "--margin-left": String(pdfOptions.margin.left),
+                '--margin-left': String(pdfOptions.margin.left),
-                "--margin-right": String(pdfOptions.margin.right),
+                '--margin-right': String(pdfOptions.margin.right),
-                "--margin-top": String(pdfOptions.margin.top),
+                '--margin-top': String(pdfOptions.margin.top),
-                "--margin-bottom": String(pdfOptions.margin.bottom),
+                '--margin-bottom': String(pdfOptions.margin.bottom),
-                "--pdf-default-font-size": String(pdfOptions.fontSize),
+                '--pdf-default-font-size': String(pdfOptions.fontSize),
-                "--pdf-mono-font-size": String(pdfOptions.fontSize),
+                '--pdf-mono-font-size': String(pdfOptions.fontSize),
-                "--paper-size": String(pdfOptions.paperSize),
+                '--paper-size': String(pdfOptions.paperSize),
-                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers),
+                '--pdf-page-numbers': Boolean(pdfOptions.pageNumbers),
-                "--pdf-header-template": String(pdfOptions.headerTemplate) || "<p class='header'><span>"+that.options.title+"</span></p>",
+                '--pdf-header-template': that.getPDFTemplate('header'),
-                "--pdf-footer-template": String(pdfOptions.footerTemplate) || "<p class='footer'><span>_SECTION_</span> <span style='float:right;'>_PAGENUM_</span></p>"
+                '--pdf-footer-template': that.getPDFTemplate('footer'),
+                '--pdf-sans-family': String(pdfOptions.fontFamily)
             });
-        } else if (that.ebookFormat == "epub") {
+        } else if (that.ebookFormat == 'epub') {
             _.extend(_options, {
-                "--dont-split-on-page-breaks": true
+                '--dont-split-on-page-breaks': true
             });
         }
 
         var command = [
-            "ebook-convert",
+            'ebook-convert',
-            path.join(that.options.output, "SUMMARY.html"),
+            path.join(that.options.output, 'SUMMARY.html'),
-            path.join(that.options.output, "index."+that.ebookFormat),
+            path.join(that.options.output, 'index.'+that.ebookFormat),
             stringUtils.optionsToShellArgs(_options)
-        ].join(" ");
+        ].join(' ');
 
-        that.book.log.info("start conversion to", that.ebookFormat, "....");
+        that.book.log.info('start conversion to', that.ebookFormat, '....');
 
         var child = exec(command, function (error, stdout) {
             if (error) {
                 that.book.log.info.fail();
 
                 if (error.code == 127) {
-                    error.message = "Need to install ebook-convert from Calibre";
+                    error.message = 'Need to install ebook-convert from Calibre';
                 } else {
-                    error.message = error.message + " "+stdout;
+                    error.message = error.message + ' '+stdout;
                 }
                 return d.reject(error);
             }
@@ -124,11 +157,11 @@ Generator.prototype.finish = function() {
             d.resolve();
         });
 
-        child.stdout.on("data", function (data) {
+        child.stdout.on('data', function (data) {
             that.book.log.debug(data);
         });
 
-        child.stderr.on("data", function (data) {
+        child.stderr.on('data', function (data) {
             that.book.log.debug(data);
         });
 

lib/generators/json.js

@@ -1,11 +1,11 @@
-var util = require("util");
+var util = require('util');
-var path = require("path");
+var path = require('path');
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
 
-var fs = require("../utils/fs");
+var fs = require('../utils/fs');
-var BaseGenerator = require("../generator");
+var BaseGenerator = require('../generator');
-var links = require("../utils/links");
+var links = require('../utils/links');
 
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
@@ -26,7 +26,7 @@ Generator.prototype.convertFile = function(input) {
             sections: page.sections
         };
 
-        var output = links.changeExtension(page.path, ".json");
+        var output = links.changeExtension(page.path, '.json');
         output = path.join(that.options.output, output);
 
         return fs.writeFile(
@@ -51,7 +51,7 @@ Generator.prototype.writeReadme = function() {
         langs = that.book.langs;
         mainLang = langs.length > 0? _.first(langs).lang : null;
 
-        readme = links.changeExtension(that.book.readmeFile, ".json");
+        readme = links.changeExtension(that.book.readmeFile, '.json');
 
         // Read readme from main language
         return fs.readFile(
@@ -67,7 +67,7 @@ Generator.prototype.writeReadme = function() {
 
         // Write it as README.json
         return fs.writeFile(
-            path.join(that.options.output, "README.json"),
+            path.join(that.options.output, 'README.json'),
             JSON.stringify(json, null, 4)
         );
     });

lib/generators/website.js

@@ -1,18 +1,18 @@
-var util = require("util");
+var util = require('util');
-var path = require("path");
+var path = require('path');
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
 
-var nunjucks = require("nunjucks");
+var nunjucks = require('nunjucks');
-var AutoEscapeExtension = require("nunjucks-autoescape")(nunjucks);
+var AutoEscapeExtension = require('nunjucks-autoescape')(nunjucks);
-var FilterExtension = require("nunjucks-filter")(nunjucks);
+var FilterExtension = require('nunjucks-filter')(nunjucks);
 
-var fs = require("../utils/fs");
+var fs = require('../utils/fs');
-var BaseGenerator = require("../generator");
+var BaseGenerator = require('../generator');
-var links = require("../utils/links");
+var links = require('../utils/links');
-var i18n = require("../utils/i18n");
+var i18n = require('../utils/i18n');
 
-var pkg = require("../../package.json");
+var pkg = require('../../package.json');
 
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
@@ -21,10 +21,10 @@ var Generator = function() {
     this.revision = new Date();
 
     // Resources namespace
-    this.namespace = "website";
+    this.namespace = 'website';
 
     // Style to integrates in the output
-    this.styles = ["website"];
+    this.styles = ['website'];
 
     // Convert images (svg -> png)
     this.convertImages = false;
@@ -63,9 +63,9 @@ Generator.prototype.prepareStyles = function() {
 
 // Prepare templates
 Generator.prototype.prepareTemplates = function() {
-    this.templates.page = this.book.plugins.template("site:page") || path.resolve(this.options.theme, "templates/website/page.html");
+    this.templates.page = this.book.plugins.template('site:page') || path.resolve(this.options.theme, 'templates/website/page.html');
-    this.templates.langs = this.book.plugins.template("site:langs") || path.resolve(this.options.theme, "templates/website/langs.html");
+    this.templates.langs = this.book.plugins.template('site:langs') || path.resolve(this.options.theme, 'templates/website/langs.html');
-    this.templates.glossary = this.book.plugins.template("site:glossary") || path.resolve(this.options.theme, "templates/website/glossary.html");
+    this.templates.glossary = this.book.plugins.template('site:glossary') || path.resolve(this.options.theme, 'templates/website/glossary.html');
 
     return Q();
 };
@@ -79,7 +79,7 @@ Generator.prototype.prepareTemplateEngine = function() {
         var language = that.book.config.normalizeLanguage();
 
         if (!i18n.hasLocale(language)) {
-            that.book.log.warn.ln("Language '"+language+"' is not available as a layout locales (en, "+i18n.getLocales().join(", ")+")");
+            that.book.log.warn.ln('Language "'+language+'" is not available as a layout locales (en, '+i18n.getLocales().join(', ')+')');
         }
 
         var folders = _.chain(that.templates)
@@ -96,14 +96,14 @@ Generator.prototype.prepareTemplateEngine = function() {
         );
 
         // Add filter
-        that.env.addFilter("contentLink", that.book.contentLink.bind(that.book));
+        that.env.addFilter('contentLink', that.book.contentLink.bind(that.book));
-        that.env.addFilter("lvl", function(lvl) {
+        that.env.addFilter('lvl', function(lvl) {
-            return lvl.split(".").length;
+            return lvl.split('.').length;
         });
 
         // Add extension
-        that.env.addExtension("AutoEscapeExtension", new AutoEscapeExtension(that.env));
+        that.env.addExtension('AutoEscapeExtension', new AutoEscapeExtension(that.env));
-        that.env.addExtension("FilterExtension", new FilterExtension(that.env));
+        that.env.addExtension('FilterExtension', new FilterExtension(that.env));
     });
 };
 
@@ -112,7 +112,6 @@ Generator.prototype.finish = function() {
     return this.copyAssets()
     .then(this.copyCover)
     .then(this.writeGlossary)
-    .then(this.writeSearchIndex)
     .then(this.writeLangsIndex);
 };
 
@@ -123,20 +122,20 @@ Generator.prototype.convertFile = function(input) {
     return that.book.parsePage(input, {
         convertImages: that.convertImages,
         interpolateTemplate: function(page) {
-            return that.callHook("page:before", page);
+            return that.callHook('page:before', page);
         },
         interpolateContent: function(page) {
-            return that.callHook("page", page);
+            return that.callHook('page', page);
         }
     })
     .then(function(page) {
         var relativeOutput = that.book.contentPath(page.path);
         var output = path.join(that.options.output, relativeOutput);
 
-        var basePath = path.relative(path.dirname(output), that.options.output) || ".";
+        var basePath = path.relative(path.dirname(output), that.options.output) || '.';
-        if (process.platform === "win32") basePath = basePath.replace(/\\/g, "/");
+        if (process.platform === 'win32') basePath = basePath.replace(/\\/g, '/');
 
-        that.book.log.debug.ln("write parsed file", page.path, "to", relativeOutput);
+        that.book.log.debug.ln('write parsed file', page.path, 'to', relativeOutput);
 
         return that._writeTemplate(that.templates.page, {
             progress: page.progress,
@@ -145,7 +144,7 @@ Generator.prototype.convertFile = function(input) {
             content: page.sections,
 
             basePath: basePath,
-            staticBase: links.join(basePath, "gitbook")
+            staticBase: links.join(basePath, 'gitbook')
         }, output);
     });
 };
@@ -156,7 +155,7 @@ Generator.prototype.writeLangsIndex = function() {
 
     return this._writeTemplate(this.templates.langs, {
         langs: this.book.langs
-    }, path.join(this.options.output, "index.html"));
+    }, path.join(this.options.output, 'index.html'));
 };
 
 // Write glossary
@@ -164,15 +163,7 @@ Generator.prototype.writeGlossary = function() {
     // No glossary
     if (this.book.glossary.length === 0) return Q();
 
-    return this._writeTemplate(this.templates.glossary, {}, path.join(this.options.output, "GLOSSARY.html"));
+    return this._writeTemplate(this.templates.glossary, {}, path.join(this.options.output, 'GLOSSARY.html'));
-};
-
-// Write the search index
-Generator.prototype.writeSearchIndex = function() {
-    return fs.writeFile(
-        path.join(this.options.output, "search_index.json"),
-        JSON.stringify(this.book.searchIndex)
-    );
 };
 
 // Convert a page into a normalized data set
@@ -189,7 +180,7 @@ Generator.prototype.normalizePage  = function(page) {
 
     return Q()
     .then(function() {
-        return _callHook("page");
+        return _callHook('page');
     })
     .then(function() {
         return page;
@@ -217,6 +208,7 @@ Generator.prototype._writeTemplate = function(tpl, options, output, interpolate)
                 title: that.options.title,
                 description: that.options.description,
                 language: that.book.config.normalizeLanguage(),
+                innerlanguage: that.book.isSubBook()? that.book.config.get('language') : null,
 
                 glossary: that.book.glossary,
 
@@ -231,10 +223,10 @@ Generator.prototype._writeTemplate = function(tpl, options, output, interpolate)
 
                 options: that.options,
 
-                basePath: ".",
+                basePath: '.',
-                staticBase: path.join(".", "gitbook"),
+                staticBase: path.join('.', 'gitbook'),
 
-                "__": that.book.i18n.bind(that.book)
+                '__': that.book.i18n.bind(that.book)
             }, options)
         );
     })
@@ -253,15 +245,15 @@ Generator.prototype.copyAssets = function() {
 
     // Copy gitbook assets
     return fs.copy(
-        path.join(that.options.theme, "assets"),
+        path.join(that.options.theme, 'assets/'+this.namespace),
-        path.join(that.options.output, "gitbook")
+        path.join(that.options.output, 'gitbook')
     )
 
     // Copy plugins assets
     .then(function() {
         return Q.all(
             _.map(that.book.plugins.list, function(plugin) {
-                var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name);
+                var pluginAssets = path.join(that.options.output, 'gitbook/plugins/', plugin.name);
                 return plugin.copyAssets(pluginAssets, that.namespace);
             })
         );

lib/index.js

@@ -1,50 +1,56 @@
-var Q = require("q");
+/* eslint no-console: 0 */
-var _ = require("lodash");
-var path = require("path");
-var tinylr = require("tiny-lr");
-var color = require("bash-color");
 
-var Book = require("./book");
+var Q = require('q');
-var Server = require("./utils/server");
+var _ = require('lodash');
-var stringUtils = require("./utils/string");
+var path = require('path');
-var watch = require("./utils/watch");
+var tinylr = require('tiny-lr');
-var logger = require("./utils/logger");
+var color = require('bash-color');
+
+var Book = require('./book');
+var initBook = require('./init');
+var Server = require('./utils/server');
+var stringUtils = require('./utils/string');
+var watch = require('./utils/watch');
+var logger = require('./utils/logger');
 
 var LOG_OPTION = {
-    name: "log",
+    name: 'log',
-    description: "Minimum log level to display",
+    description: 'Minimum log level to display',
     values: _.chain(logger.LEVELS).keys().map(stringUtils.toLowerCase).value(),
-    defaults: "info"
+    defaults: 'info'
 };
 
 var FORMAT_OPTION = {
-    name: "format",
+    name: 'format',
-    description: "Format to build to",
+    description: 'Format to build to',
-    values: ["website", "json", "ebook"],
+    values: ['website', 'json', 'ebook'],
-    defaults: "website"
+    defaults: 'website'
 };
 
+// Export init to gitbook library
+Book.init = initBook;
+
 module.exports = {
     Book: Book,
     LOG_LEVELS: logger.LEVELS,
 
     commands: _.flatten([
         {
-            name: "build [book] [output]",
+            name: 'build [book] [output]',
-            description: "build a book",
+            description: 'build a book',
             options: [
                 FORMAT_OPTION,
                 LOG_OPTION
             ],
             exec: function(args, kwargs) {
                 var input = args[0] || process.cwd();
-                var output = args[1] || path.join(input, "_book");
+                var output = args[1] || path.join(input, '_book');
 
                 var book = new Book(input, _.extend({}, {
-                    "config": {
+                    'config': {
-                        "output": output
+                        'output': output
                     },
-                    "logLevel": kwargs.log
+                    'logLevel': kwargs.log
                 }));
 
                 return book.parse()
@@ -52,16 +58,16 @@ module.exports = {
                     return book.generate(kwargs.format);
                 })
                 .then(function(){
-                    console.log("");
+                    console.log('');
-                    console.log(color.green("Done, without error"));
+                    console.log(color.green('Done, without error'));
                 });
             }
         },
 
-        _.map(["pdf", "epub", "mobi"], function(ebookType) {
+        _.map(['pdf', 'epub', 'mobi'], function(ebookType) {
             return {
-                name: ebookType+" [book] [output]",
+                name: ebookType+' [book] [output]',
-                description: "build a book to "+ebookType,
+                description: 'build a book to '+ebookType,
                 options: [
                     LOG_OPTION
                 ],
@@ -70,7 +76,7 @@ module.exports = {
                     var output = args[1];
 
                     var book = new Book(input, _.extend({}, {
-                        "logLevel": kwargs.log
+                        'logLevel': kwargs.log
                     }));
 
                     return book.parse()
@@ -80,30 +86,30 @@ module.exports = {
                         });
                     })
                     .then(function(){
-                        console.log("");
+                        console.log('');
-                        console.log(color.green("Done, without error"));
+                        console.log(color.green('Done, without error'));
                     });
                 }
             };
         }),
 
         {
-            name: "serve [book]",
+            name: 'serve [book]',
-            description: "Build then serve a gitbook from a directory",
+            description: 'Build then serve a gitbook from a directory',
             options: [
                 {
-                    name: "port",
+                    name: 'port',
-                    description: "Port for server to listen on",
+                    description: 'Port for server to listen on',
                     defaults: 4000
                 },
                 {
-                    name: "lrport",
+                    name: 'lrport',
-                    description: "Port for livereload server to listen on",
+                    description: 'Port for livereload server to listen on',
                     defaults: 35729
                 },
                 {
-                    name: "watch",
+                    name: 'watch',
-                    description: "Enable/disable file watcher",
+                    description: 'Enable/disable file watcher',
                     defaults: true
                 },
                 FORMAT_OPTION,
@@ -118,15 +124,15 @@ module.exports = {
                 var lrPath;
 
                 var generate = function() {
-                    if (server.isRunning()) console.log("Stopping server");
+                    if (server.isRunning()) console.log('Stopping server');
 
                     return server.stop()
                     .then(function() {
                         var book = new Book(input, _.extend({}, {
-                            "config": {
+                            'config': {
-                                "defaultsPlugins": ["livereload"]
+                                'defaultsPlugins': ['livereload']
                             },
-                            "logLevel": kwargs.log
+                            'logLevel': kwargs.log
                         }));
 
                         return book.parse()
@@ -137,10 +143,10 @@ module.exports = {
                     })
                     .then(function(book) {
                         console.log();
-                        console.log("Starting server ...");
+                        console.log('Starting server ...');
                         return server.start(book.options.output, kwargs.port)
                         .then(function() {
-                            console.log("Serving book on http://localhost:"+kwargs.port);
+                            console.log('Serving book on http://localhost:'+kwargs.port);
 
                             if (lrPath) {
                                 // trigger livereload
@@ -157,8 +163,8 @@ module.exports = {
                             .then(function(filepath) {
                                 // set livereload path
                                 lrPath = filepath;
-                                console.log("Restart after change in file", filepath);
+                                console.log('Restart after change in file', filepath);
-                                console.log("");
+                                console.log('');
                                 return generate();
                             });
                         });
@@ -167,17 +173,17 @@ module.exports = {
 
                 return Q.nfcall(lrServer.listen.bind(lrServer), kwargs.lrport)
                 .then(function() {
-                    console.log("Live reload server started on port:", kwargs.lrport);
+                    console.log('Live reload server started on port:', kwargs.lrport);
-                    console.log("Press CTRL+C to quit ...");
+                    console.log('Press CTRL+C to quit ...');
-                    console.log("");
+                    console.log('');
                     return generate();
                 });
             }
         },
 
         {
-            name: "install [book]",
+            name: 'install [book]',
-            description: "install plugins dependencies",
+            description: 'install plugins dependencies',
             exec: function(args) {
                 var input = args[0] || process.cwd();
 
@@ -188,20 +194,20 @@ module.exports = {
                     return book.plugins.install();
                 })
                 .then(function(){
-                    console.log("");
+                    console.log('');
-                    console.log(color.green("Done, without error"));
+                    console.log(color.green('Done, without error'));
                 });
             }
         },
 
         {
-            name: "init [directory]",
+            name: 'init [directory]',
-            description: "create files and folders based on contents of SUMMARY.md",
+            description: 'create files and folders based on contents of SUMMARY.md',
             exec: function(args) {
-                return Book.init(args[0] || process.cwd())
+                return initBook(args[0] || process.cwd())
                 .then(function(){
-                    console.log("");
+                    console.log('');
-                    console.log(color.green("Done, without error"));
+                    console.log(color.green('Done, without error'));
                 });
             }
         }

lib/init.js

@@ -0,0 +1,83 @@
+var _ = require('lodash');
+var Q = require('q');
+var path = require('path');
+
+var Book = require('./book');
+var fs = require('./utils/fs');
+
+// Initialize folder structure for a book
+// Read SUMMARY to created the right chapter
+function initBook(root, opts) {
+    var book = new Book(root, opts);
+    var extensionToUse = '.md';
+
+    var chaptersPaths = function(chapters) {
+        return _.reduce(chapters || [], function(accu, chapter) {
+            var o = {
+                title: chapter.title
+            };
+            if (chapter.path) o.path = chapter.path;
+
+            return accu.concat(
+                [o].concat(chaptersPaths(chapter.articles))
+            );
+        }, []);
+    };
+
+    book.log.info.ln('init book at', root);
+    return fs.mkdirp(root)
+    .then(function() {
+        book.log.info.ln('detect structure from SUMMARY (if it exists)');
+        return book.parseSummary();
+    })
+    .fail(function() {
+        return Q();
+    })
+    .then(function() {
+        var summary = book.summaryFile || 'SUMMARY.md';
+        var chapters = book.summary.chapters || [];
+        extensionToUse = path.extname(summary);
+
+        if (chapters.length === 0) {
+            chapters = [
+                {
+                    title: 'Summary',
+                    path: 'SUMMARY'+extensionToUse
+                },
+                {
+                    title: 'Introduction',
+                    path: 'README'+extensionToUse
+                }
+            ];
+        }
+
+        return Q(chaptersPaths(chapters));
+    })
+    .then(function(chapters) {
+        // Create files that don't exist
+        return Q.all(_.map(chapters, function(chapter) {
+            if (!chapter.path) return Q();
+            var absolutePath = path.resolve(book.root, chapter.path);
+
+            return fs.exists(absolutePath)
+            .then(function(exists) {
+                if(exists) {
+                    book.log.info.ln('found', chapter.path);
+                    return;
+                } else {
+                    book.log.info.ln('create', chapter.path);
+                }
+
+                return fs.mkdirp(path.dirname(absolutePath))
+                .then(function() {
+                    return fs.writeFile(absolutePath, '# '+chapter.title+'\n');
+                });
+            });
+        }));
+    })
+    .then(function() {
+        book.log.info.ln('initialization is finished');
+    });
+}
+
+module.exports = initBook;

lib/plugin.js

@@ -1,16 +1,27 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var Q = require("q");
+var Q = require('q');
-var semver = require("semver");
+var path = require('path');
-var path = require("path");
+var url = require('url');
-var url = require("url");
+var fs = require('./utils/fs');
-var fs = require("./utils/fs");
+var resolve = require('resolve');
-var resolve = require("resolve");
+var mergeDefaults = require('merge-defaults');
+var jsonschema = require('jsonschema');
+var jsonSchemaDefaults = require('json-schema-defaults');
+
+var version = require('./version');
+
+var PLUGIN_PREFIX = 'gitbook-plugin-';
+
+// Return an absolute name for the plugin (the one on NPM)
+function absoluteName(name) {
+    if (name.indexOf(PLUGIN_PREFIX) === 0) return name;
+    return [PLUGIN_PREFIX, name].join('');
+}
 
-var pkg = require("../package.json");
 
 var Plugin = function(book, name) {
     this.book = book;
-    this.name = name;
+    this.name = absoluteName(name);
     this.packageInfos = {};
     this.infos = {};
 
@@ -18,9 +29,8 @@ var Plugin = function(book, name) {
     _.bindAll(this);
 
     _.each([
-        "gitbook-plugin-"+name,
+        absoluteName(name),
-        "gitbook-"+name,
+        name
-        name,
     ], function(_name) {
         // Load from the book
         if (this.load(_name, book.root)) return false;
@@ -31,20 +41,27 @@ var Plugin = function(book, name) {
 };
 
 // Type of plugins resources
-Plugin.RESOURCES = ["js", "css"];
+Plugin.RESOURCES = ['js', 'css'];
 Plugin.HOOKS = [
-    "init", "finish", "finish:before", "page", "page:before"
+    'init', 'finish', 'finish:before', 'config', 'page', 'page:before'
 ];
 
+// Return the reduce name for the plugin
+// "gitbook-plugin-test" -> "test"
+// Return a relative name for the plugin (the one on GitBook)
+Plugin.prototype.reducedName = function() {
+    return this.name.replace(PLUGIN_PREFIX, '');
+};
+
 // Load from a name
 Plugin.prototype.load = function(name, baseDir) {
     try {
-        var res = resolve.sync(name+"/package.json", { basedir: baseDir });
+        var res = resolve.sync(name+'/package.json', { basedir: baseDir });
 
         this.baseDir = path.dirname(res);
         this.packageInfos = require(res);
         this.infos = require(resolve.sync(name, { basedir: baseDir }));
-        this.name = name;
+        this.name = this.packageInfos.name;
 
         return true;
     } catch (e) {
@@ -62,13 +79,13 @@ Plugin.prototype.normalizeResource = function(resource) {
     // so we will simply link to using it's URL
     if (parsed.protocol) {
         return {
-            "url": resource
+            'url': resource
         };
     }
 
     // This will be copied over from disk
     // and shipped with the book's build
-    return { "path": this.name+"/"+resource };
+    return { 'path': this.name+'/'+resource };
 };
 
 // Return resources
@@ -77,7 +94,7 @@ Plugin.prototype._getResources = function(base) {
     var book = this.infos[base];
 
     // Compatibility with version 1.x.x
-    if (base == "website") book = book || this.infos.book;
+    if (base == 'website') book = book || this.infos.book;
 
     // Nothing specified, fallback to default
     if (!book) {
@@ -85,7 +102,7 @@ Plugin.prototype._getResources = function(base) {
     }
 
     // Dynamic function
-    if(typeof book === "function") {
+    if(typeof book === 'function') {
         // Call giving it the context of our book
         return Q().then(book.bind(this.book));
     }
@@ -127,18 +144,49 @@ Plugin.prototype.isValid = function() {
         this.packageInfos.name &&
         this.packageInfos.engines &&
         this.packageInfos.engines.gitbook &&
-        semver.satisfies(pkg.version, this.packageInfos.engines.gitbook)
+        version.satisfies(this.packageInfos.engines.gitbook)
     );
 
     // Valid hooks
     _.each(this.infos.hooks, function(hook, hookName) {
         if (_.contains(Plugin.HOOKS, hookName)) return;
-        that.book.log.warn.ln("Hook '"+hookName+" 'used by plugin '"+that.packageInfos.name+"' has been removed or is deprecated");
+        that.book.log.warn.ln('Hook "'+hookName+'"" used by plugin "'+that.packageInfos.name+'" has been removed or is deprecated');
     });
 
     return isValid;
 };
 
+// Normalize, validate configuration for this plugin using its schema
+// Throw an error when shcema is not respected
+Plugin.prototype.validateConfig = function(config) {
+    var that = this;
+
+    return Q()
+    .then(function() {
+        var schema = that.packageInfos.gitbook || {};
+        if (!schema) return config;
+
+        // Normalize schema
+        schema.id = '/pluginsConfig.'+that.reducedName();
+        schema.type = 'object';
+
+        // Validate and throw if invalid
+        var v = new jsonschema.Validator();
+        var result = v.validate(config, schema, {
+            propertyName: 'pluginsConfig.'+that.reducedName()
+        });
+
+        // Throw error
+        if (result.errors.length > 0) {
+            throw new Error('Configuration Error: '+result.errors[0].stack);
+        }
+
+        // Insert default values
+        var defaults = jsonSchemaDefaults(schema);
+        return mergeDefaults(config, defaults);
+    });
+};
+
 // Resolve file path
 Plugin.prototype.resolveFile = function(filename) {
     return path.resolve(this.baseDir, filename);
@@ -154,8 +202,8 @@ Plugin.prototype.callHook = function(name, data) {
 
     if (!hookFunc) return Q(data);
 
-    this.book.log.debug.ln("call hook", name);
+    this.book.log.debug.ln('call hook', name);
-    if (!_.contains(Plugin.HOOKS, name)) this.book.log.warn.ln("hook '"+name+"' used by plugin '"+this.name+"' is deprecated, and will be removed in the coming versions");
+    if (!_.contains(Plugin.HOOKS, name)) this.book.log.warn.ln('hook "'+name+'" used by plugin "'+this.name+'" is deprecated, and will be removed in the coming versions');
 
     return Q()
     .then(function() {
@@ -168,7 +216,7 @@ Plugin.prototype.copyAssets = function(out, base) {
     var that = this;
 
     return this.getResources(base)
-    .get("assets")
+    .get('assets')
     .then(function(assets) {
         // Assets are undefined
         if(!assets) return false;
@@ -180,4 +228,14 @@ Plugin.prototype.copyAssets = function(out, base) {
     }, _.constant(false));
 };
 
+// Get config from book
+Plugin.prototype.getConfig = function() {
+    return this.book.config.get('pluginsConfig.'+this.reducedName(), {});
+};
+
+// Set configuration for this plugin
+Plugin.prototype.setConfig = function(values) {
+    return this.book.config.set('pluginsConfig.'+this.reducedName(), values);
+};
+
 module.exports = Plugin;

lib/pluginslist.js

@@ -1,14 +1,14 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var Q = require("q");
+var Q = require('q');
-var npmi = require("npmi");
+var npmi = require('npmi');
-var npm = require("npm");
+var npm = require('npm');
-var semver = require("semver");
+var semver = require('semver');
 
-var Plugin = require("./plugin");
+var Plugin = require('./plugin');
-var pkg = require("../package.json");
+var version = require('./version');
 
 var initNPM = _.memoize(function() {
-    return Q.nfcall(npm.load, { silent: true, loglevel: "silent" });
+    return Q.nfcall(npm.load, { silent: true, loglevel: 'silent' });
 });
 
 
@@ -23,7 +23,7 @@ var PluginsList = function(book, plugins) {
     this.failed = [];
 
     // Namespaces
-    this.namespaces = _.chain(["website", "ebook"])
+    this.namespaces = _.chain(['website', 'ebook'])
         .map(function(namespace) {
             return [
                 namespace,
@@ -66,7 +66,7 @@ PluginsList.prototype.load = function(plugin) {
     if (_.isObject(plugin) && !(plugin instanceof Plugin)) plugin = plugin.name;
     if (_.isString(plugin)) plugin = new Plugin(this.book, plugin);
 
-    that.log.info("load plugin", plugin.name, "....");
+    that.log.info('load plugin', plugin.name, '....');
     if (!plugin.isValid()) {
         that.log.info.fail();
         that.failed.push(plugin.name);
@@ -78,34 +78,46 @@ PluginsList.prototype.load = function(plugin) {
         that.list.push(plugin);
     }
 
-    // Extract filters
+    return Q()
-    that.book.template.addFilters(plugin.getFilters());
 
-    // Extract blocks
+    // Validate and normalize configuration
-    that.book.template.addBlocks(plugin.getBlocks());
+    .then(function() {
+        var config = plugin.getConfig();
+        return plugin.validateConfig(config);
+    })
+    .then(function(config) {
+        // Update configuration
+        plugin.setConfig(config);
 
-    return _.reduce(_.keys(that.namespaces), function(prev, namespaceName) {
+        // Extract filters
-        return prev.then(function() {
+        that.book.template.addFilters(plugin.getFilters());
-            return plugin.getResources(namespaceName)
-            .then(function(plResources) {
-                var namespace = that.namespaces[namespaceName];
 
-                // Extract js and css
+        // Extract blocks
-                _.each(Plugin.RESOURCES, function(resourceType) {
+        that.book.template.addBlocks(plugin.getBlocks());
-                    namespace.resources[resourceType] = (namespace.resources[resourceType] || []).concat(plResources[resourceType] || []);
-                });
 
-                // Map of html resources by name added by each plugin
+        return _.reduce(_.keys(that.namespaces), function(prev, namespaceName) {
-                _.each(plResources.html || {}, function(value, tag) {
+            return prev.then(function() {
-                    // Turn into function if not one already
+                return plugin.getResources(namespaceName)
-                    if (!_.isFunction(value)) value = _.constant(value);
+                .then(function(plResources) {
+                    var namespace = that.namespaces[namespaceName];
 
-                    namespace.html[tag] = namespace.html[tag] || [];
+                    // Extract js and css
-                    namespace.html[tag].push(value);
+                    _.each(Plugin.RESOURCES, function(resourceType) {
+                        namespace.resources[resourceType] = (namespace.resources[resourceType] || []).concat(plResources[resourceType] || []);
+                    });
+
+                    // Map of html resources by name added by each plugin
+                    _.each(plResources.html || {}, function(value, tag) {
+                        // Turn into function if not one already
+                        if (!_.isFunction(value)) value = _.constant(value);
+
+                        namespace.html[tag] = namespace.html[tag] || [];
+                        namespace.html[tag].push(value);
+                    });
                 });
             });
-        });
+        }, Q());
-    }, Q());
+    });
 };
 
 // Call a hook
@@ -135,7 +147,7 @@ PluginsList.prototype.html = function(namespace, tag, context, options) {
     var htmlSnippets = this.namespaces[namespace].html[tag];
     return _.map(htmlSnippets || [], function(code) {
         return code.call(context, options);
-    }).join("\n");
+    }).join('\n');
 };
 
 // Return a resources map for a namespace
@@ -153,10 +165,10 @@ PluginsList.prototype.install = function() {
     });
 
     // Install plugins one by one
-    that.book.log.info.ln(plugins.length+" plugins to install");
+    that.book.log.info.ln(plugins.length+' plugins to install');
     return _.reduce(plugins, function(prev, plugin) {
         return prev.then(function() {
-            var fullname = "gitbook-plugin-"+plugin.name;
+            var fullname = 'gitbook-plugin-'+plugin.name;
 
             return Q()
 
@@ -164,10 +176,10 @@ PluginsList.prototype.install = function() {
             .then(function() {
                 if (plugin.version) return plugin.version;
 
-                that.book.log.info.ln("No version specified, resolve plugin", plugin.name);
+                that.book.log.info.ln('No version specified, resolve plugin', plugin.name);
                 return initNPM()
                 .then(function() {
-                    return Q.nfcall(npm.commands.view, [fullname+"@*", "engines"], true);
+                    return Q.nfcall(npm.commands.view, [fullname+'@*', 'engines'], true);
                 })
                 .then(function(versions) {
                     return _.chain(versions)
@@ -179,12 +191,12 @@ PluginsList.prototype.install = function() {
                             };
                         })
                         .filter(function(v) {
-                            return v.gitbook && semver.satisfies(pkg.version, v.gitbook);
+                            return v.gitbook && version.satisfies(v.gitbook);
                         })
                         .sort(function(v1, v2) {
                             return semver.lt(v1.version, v2.version)? 1 : -1;
                         })
-                        .pluck("version")
+                        .pluck('version')
                         .first()
                         .value();
                 });
@@ -193,23 +205,23 @@ PluginsList.prototype.install = function() {
             // Install the plugin with the resolved version
             .then(function(version) {
                 if (!version) {
-                    throw "Found no satisfactory version for plugin "+plugin.name;
+                    throw 'Found no satisfactory version for plugin '+plugin.name;
                 }
 
-                that.book.log.info.ln("install plugin", plugin.name, "from npm ("+fullname+") with version", version);
+                that.book.log.info.ln('install plugin', plugin.name, 'from npm ('+fullname+') with version', version);
                 return Q.nfcall(npmi, {
-                    "name": fullname,
+                    'name': fullname,
-                    "version": version,
+                    'version': version,
-                    "path": that.book.root,
+                    'path': that.book.root,
-                    "npmLoad": {
+                    'npmLoad': {
-                        "loglevel": "silent",
+                        'loglevel': 'silent',
-                        "loaded": true,
+                        'loaded': true,
-                        "prefix": that.book.root
+                        'prefix': that.book.root
                     }
                 });
             })
             .then(function() {
-                that.book.log.info.ok("plugin", plugin.name, "installed with success");
+                that.book.log.info.ok('plugin', plugin.name, 'installed with success');
             });
         });
     }, Q());

lib/template.js

@@ -1,12 +1,14 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var Q = require("q");
+var Q = require('q');
-var nunjucks = require("nunjucks");
+var path = require('path');
-var escapeStringRegexp = require("escape-string-regexp");
+var nunjucks = require('nunjucks');
+var parsers = require('gitbook-parsers');
+var escapeStringRegexp = require('escape-string-regexp');
 
-var batch = require("./utils/batch");
+var batch = require('./utils/batch');
-var pkg = require("../package.json");
+var pkg = require('../package.json');
-var defaultBlocks = require("./blocks");
+var defaultBlocks = require('./blocks');
-var BookLoader = require("./conrefs_loader");
+var BookLoader = require('./conrefs_loader');
 
 // Normalize result from a block
 function normBlockResult(blk) {
@@ -16,24 +18,37 @@ function normBlockResult(blk) {
 
 
 var TemplateEngine = function(book) {
+    var that = this;
+
     this.book = book;
     this.log = this.book.log;
 
+    // Template loader
+    this.loader = new BookLoader(book, {
+        // Replace shortcuts in imported files
+        interpolate: function(filepath, source) {
+            var parser = parsers.get(path.extname(filepath));
+            var type = parser? parser.name : null;
+
+            return  that.applyShortcuts(type, source);
+        }
+    });
+
     // Nunjucks env
     this.env = new nunjucks.Environment(
-        new BookLoader(book),
+        this.loader,
         {
             // Escaping is done after by the markdown parser
             autoescape: false,
 
             // Tags
             tags: {
-                blockStart: "{%",
+                blockStart: '{%',
-                blockEnd: "%}",
+                blockEnd: '%}',
-                variableStart: "{{",
+                variableStart: '{{',
-                variableEnd: "}}",
+                variableEnd: '}}',
-                commentStart: "{###",
+                commentStart: '{###',
-                commentEnd: "###}"
+                commentEnd: '###}'
             }
         }
     );
@@ -60,20 +75,20 @@ TemplateEngine.prototype.processBlock = function(blk) {
         parse: false,
         post: undefined
     });
-    blk.id = _.uniqueId("blk");
+    blk.id = _.uniqueId('blk');
 
     var toAdd = (!blk.parse) || (blk.post !== undefined);
 
     // Add to global map
     if (toAdd) this.blockBodies[blk.id] = blk;
 
-    //Parsable block, just return it
+    // Parsable block, just return it
     if (blk.parse) {
         return blk.body;
     }
 
     // Return it as a position marker
-    return "@%@"+blk.id+"@%@";
+    return '@%@'+blk.id+'@%@';
 };
 
 // Replace position markers of blocks by body after processing
@@ -110,11 +125,13 @@ TemplateEngine.prototype.bindContext = function(func) {
 TemplateEngine.prototype.addFilter = function(filterName, func) {
     try {
         this.env.getFilter(filterName);
-        this.log.warn.ln("conflict in filters, \""+filterName+"\" is already set");
+        this.log.warn.ln('conflict in filters, \''+filterName+'\' is already set');
         return false;
-    } catch(e) {}
+    } catch(e) {
+        // Filter doesn't exist
+    }
 
-    this.log.debug.ln("add filter \""+filterName+"\"");
+    this.log.debug.ln('add filter \''+filterName+'\'');
     this.env.addFilter(filterName, this.bindContext(function() {
         var ctx = this;
         var args = Array.prototype.slice.apply(arguments);
@@ -138,7 +155,7 @@ TemplateEngine.prototype.addFilters = function(filters) {
 
 // Return nunjucks extension name of a block
 TemplateEngine.prototype.blockExtName = function(name) {
-    return "Block"+name+"Extension";
+    return 'Block'+name+'Extension';
 };
 
 // Test if a block is defined
@@ -167,7 +184,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
 
     block = _.defaults(block || {}, {
         shortcuts: [],
-        end: "end"+name,
+        end: 'end'+name,
         process: _.identity,
         blocks: []
     });
@@ -175,13 +192,13 @@ TemplateEngine.prototype.addBlock = function(name, block) {
     extName = this.blockExtName(name);
 
     if (this.hasBlock(name) && !defaultBlocks[name]) {
-        this.log.warn.ln("conflict in blocks, \""+name+"\" is already defined");
+        this.log.warn.ln('conflict in blocks, \''+name+'\' is already defined');
     }
 
     // Cleanup previous block
     this.removeBlock(name);
 
-    this.log.debug.ln("add block \""+name+"\"");
+    this.log.debug.ln('add block \''+name+'\'');
     this.blocks[name] = block;
 
     Ext = function () {
@@ -238,7 +255,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
                 bodies.push(subbodies[blockName][0].body);
             });
 
-            return new nodes.CallExtensionAsync(this, "run", args, bodies);
+            return new nodes.CallExtensionAsync(this, 'run', args, bodies);
         };
 
         this.run = function(context) {
@@ -287,7 +304,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
     // Add shortcuts
     if (!_.isArray(block.shortcuts)) block.shortcuts = [block.shortcuts];
     _.each(block.shortcuts, function(shortcut) {
-        this.log.debug.ln("add template shortcut from \""+shortcut.start+"\" to block \""+name+"\" for parsers ", shortcut.parsers);
+        this.log.debug.ln('add template shortcut from \''+shortcut.start+'\' to block \''+name+'\' for parsers ', shortcut.parsers);
         this.shortcuts.push({
             block: name,
             parsers: shortcut.parsers,
@@ -314,7 +331,7 @@ TemplateEngine.prototype.applyBlock = function(name, blk, ctx) {
     var func, block, r;
 
     block = this.blocks[name];
-    if (!block) throw new Error("Block not found \""+name+"\"");
+    if (!block) throw new Error('Block not found \''+name+'\'');
     if (_.isString(blk)) {
         blk = {
             body: blk
@@ -339,14 +356,19 @@ TemplateEngine.prototype.applyBlock = function(name, blk, ctx) {
 TemplateEngine.prototype._applyShortcut = function(parser, content, shortcut) {
     if (!_.contains(shortcut.parsers, parser)) return content;
     var regex = new RegExp(
-        escapeStringRegexp(shortcut.start) + "([\\s\\S]*?[^\\$])" + escapeStringRegexp(shortcut.end),
+        escapeStringRegexp(shortcut.start) + '([\\s\\S]*?[^\\$])' + escapeStringRegexp(shortcut.end),
-       "g"
+       'g'
     );
     return content.replace(regex, function(all, match) {
-        return "{% "+shortcut.tag.start+" %}"+ match + "{% "+shortcut.tag.end+" %}";
+        return '{% '+shortcut.tag.start+' %}'+ match + '{% '+shortcut.tag.end+' %}';
     });
 };
 
+// Apply all shortcuts to some template string
+TemplateEngine.prototype.applyShortcuts = function(type, content) {
+    return _.reduce(this.shortcuts, _.partial(this._applyShortcut.bind(this), type), content);
+};
+
 // Render a string from the book
 TemplateEngine.prototype.renderString = function(content, context, options) {
     context = _.extend({}, context, {
@@ -367,14 +389,18 @@ TemplateEngine.prototype.renderString = function(content, context, options) {
         type: null
     });
     if (options.path) options.path = this.book.resolve(options.path);
+    if (!options.type && options.path) {
+        var parser = parsers.get(path.extname(options.path));
+        options.type = parser? parser.name : null;
+    }
 
     // Replace shortcuts
-    content = _.reduce(this.shortcuts, _.partial(this._applyShortcut.bind(this), options.type), content);
+    content = this.applyShortcuts(options.type, content);
 
     return Q.nfcall(this.env.renderString.bind(this.env), content, context, options)
     .fail(function(err) {
         if (_.isString(err)) err = new Error(err);
-        err.message = err.message.replace(/^Error: /, "");
+        err.message = err.message.replace(/^Error: /, '');
 
         throw err;
     });
@@ -398,7 +424,7 @@ TemplateEngine.prototype.renderPage = function(page) {
 
     return that.book.statFile(page.path)
     .then(function(stat) {
-       var context = {
+        var context = {
             // infos about the file
             file: {
                 path: page.path,

lib/utils/fs.js

@@ -1,10 +1,10 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var Q = require("q");
+var Q = require('q');
-var tmp = require("tmp");
+var tmp = require('tmp');
-var path = require("path");
+var path = require('path');
-var fs = require("graceful-fs");
+var fs = require('graceful-fs');
-var fsExtra = require("fs-extra");
+var fsExtra = require('fs-extra');
-var Ignore = require("fstream-ignore");
+var Ignore = require('fstream-ignore');
 
 var fsUtils = {
     tmp: {
@@ -30,10 +30,11 @@ var fsUtils = {
         fs.exists(path, d.resolve);
         return d.promise;
     },
+    findFile: findFile,
     existsSync: fs.existsSync.bind(fs),
     readFileSync: fs.readFileSync.bind(fs),
     clean: cleanFolder,
-    getUniqueFilename: getUniqueFilename,
+    getUniqueFilename: getUniqueFilename
 };
 
 // Write a file
@@ -57,14 +58,14 @@ function writeStream(filename, st) {
 
     var wstream = fs.createWriteStream(filename);
 
-    wstream.on("finish", function () {
+    wstream.on('finish', function () {
         d.resolve();
     });
-    wstream.on("error", function (err) {
+    wstream.on('error', function (err) {
         d.reject(err);
     });
 
-    st.on("error", function(err) {
+    st.on('error', function(err) {
         d.reject(err);
     });
 
@@ -77,7 +78,7 @@ function writeStream(filename, st) {
 function getUniqueFilename(base, filename) {
     if (!filename) {
         filename = base;
-        base = "/";
+        base = '/';
     }
 
     filename = path.resolve(base, filename);
@@ -87,9 +88,8 @@ function getUniqueFilename(base, filename) {
     var _filename = filename+ext;
 
     var i = 0;
-    while (1) {
+    while (fs.existsSync(filename)) {
-        if (!fs.existsSync(filename)) break;
+        _filename = filename+'_'+i+ext;
-        _filename = filename+"_"+i+ext;
         i = i + 1;
     }
 
@@ -115,20 +115,20 @@ function listFiles(root, options) {
     });
 
     // Add extra rules to ignore common folders
-    ig.addIgnoreRules(options.ignoreRules, "__custom_stuff");
+    ig.addIgnoreRules(options.ignoreRules, '__custom_stuff');
 
     // Push each file to our list
-    ig.on("child", function (c) {
+    ig.on('child', function (c) {
         files.push(
-            c.path.substr(c.root.path.length + 1) + (c.props.Directory === true ? "/" : "")
+            c.path.substr(c.root.path.length + 1) + (c.props.Directory === true ? '/' : '')
         );
     });
 
-    ig.on("end", function() {
+    ig.on('end', function() {
         // Normalize paths on Windows
-        if(process.platform === "win32") {
+        if(process.platform === 'win32') {
             return d.resolve(files.map(function(file) {
-                return file.replace(/\\/g, "/");
+                return file.replace(/\\/g, '/');
             }));
         }
 
@@ -136,7 +136,7 @@ function listFiles(root, options) {
         return d.resolve(files);
     });
 
-    ig.on("error", d.reject);
+    ig.on('error', d.reject);
 
     return d.promise;
 }
@@ -150,8 +150,8 @@ function cleanFolder(root) {
         ignoreFiles: [],
         ignoreRules: [
             // Skip Git and SVN stuff
-            ".git/",
+            '.git/',
-            ".svn/"
+            '.svn/'
         ]
     })
     .then(function(files) {
@@ -179,4 +179,15 @@ function cleanFolder(root) {
     });
 }
 
+// Find a file in a folder (case incensitive)
+// Return the real filename
+function findFile(root, filename) {
+    return Q.nfcall(fs.readdir, root)
+    .then(function(files) {
+        return _.find(files, function(file) {
+            return (file.toLowerCase() == filename.toLowerCase());
+        });
+    });
+}
+
 module.exports = fsUtils;

lib/utils/git.js

@@ -1,14 +1,14 @@
-var  Q = require("q");
+var  Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
-var path = require("path");
+var path = require('path');
-var crc = require("crc");
+var crc = require('crc');
-var exec = Q.denodeify(require("child_process").exec);
+var exec = Q.denodeify(require('child_process').exec);
-var URI = require("URIjs");
+var URI = require('urijs');
-var pathUtil = require("./path");
+var pathUtil = require('./path');
 
-var fs = require("./fs");
+var fs = require('./fs');
 
-var GIT_PREFIX = "git+";
+var GIT_PREFIX = 'git+';
 var GIT_TMP = null;
 
 
@@ -30,20 +30,20 @@ function parseGitUrl(giturl) {
     giturl = giturl.slice(GIT_PREFIX.length);
 
     uri = new URI(giturl);
-    ref = uri.fragment() || "master";
+    ref = uri.fragment() || 'master';
     uri.fragment(null);
 
     // Extract file inside the repo (after the .git)
-    fileParts =uri.path().split(".git");
+    fileParts =uri.path().split('.git');
-    filepath = fileParts.length > 1? fileParts.slice(1).join(".git") : "";
+    filepath = fileParts.length > 1? fileParts.slice(1).join('.git') : '';
-    if (filepath[0] == "/") filepath = filepath.slice(1);
+    if (filepath[0] == '/') filepath = filepath.slice(1);
 
     // Recreate pathname without the real filename
-    uri.path(_.first(fileParts)+".git");
+    uri.path(_.first(fileParts)+'.git');
 
     return {
         host: uri.toString(),
-        ref: ref || "master",
+        ref: ref || 'master',
         filepath: filepath
     };
 }
@@ -52,7 +52,7 @@ function parseGitUrl(giturl) {
 function cloneGitRepo(host, ref) {
     var isBranch = false;
 
-    ref = ref || "master";
+    ref = ref || 'master';
     if (!validateSha(ref)) isBranch = true;
 
     return Q()
@@ -69,7 +69,7 @@ function cloneGitRepo(host, ref) {
     // Return or clone the git repo
     .then(function() {
         // Unique ID for repo/ref combinaison
-        var repoId = crc.crc32(host+"#"+ref).toString(16);
+        var repoId = crc.crc32(host+'#'+ref).toString(16);
 
         // Absolute path to the folder
         var repoPath = path.resolve(GIT_TMP, repoId);
@@ -79,9 +79,9 @@ function cloneGitRepo(host, ref) {
                 if (doExists) return;
 
                 // Clone repo
-                return exec("git clone "+host+" "+repoPath)
+                return exec('git clone '+host+' '+repoPath)
                 .then(function() {
-                    return exec("git checkout "+ref, { cwd: repoPath });
+                    return exec('git checkout '+ref, { cwd: repoPath });
                 });
             })
             .thenResolve(repoPath);

lib/utils/i18n.js

@@ -1,13 +1,13 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var path = require("path");
+var path = require('path');
-var fs = require("fs");
+var fs = require('fs');
 
-var i18n = require("i18n");
+var i18n = require('i18n');
 
-var I18N_PATH = path.resolve(__dirname, "../../theme/i18n/");
+var I18N_PATH = path.resolve(__dirname, '../../theme/i18n/');
-var DEFAULT_LANGUAGE = "en";
+var DEFAULT_LANGUAGE = 'en';
 var LOCALES = _.map(fs.readdirSync(I18N_PATH), function(lang) {
-    return path.basename(lang, ".json");
+    return path.basename(lang, '.json');
 });
 
 i18n.configure({
@@ -18,11 +18,11 @@ i18n.configure({
 });
 
 function compareLocales(lang, locale) {
-    var langMain = _.first(lang.split("-"));
+    var langMain = _.first(lang.split('-'));
-    var langSecond = _.last(lang.split("-"));
+    var langSecond = _.last(lang.split('-'));
 
-    var localeMain = _.first(locale.split("-"));
+    var localeMain = _.first(locale.split('-'));
-    var localeSecond = _.last(locale.split("-"));
+    var localeSecond = _.last(locale.split('-'));
 
     if (locale == lang) return 100;
     if (localeMain == langMain) return 50;
@@ -42,8 +42,8 @@ var normalizeLanguage = _.memoize(function(lang) {
         .filter(function(lang) {
             return lang.score > 0;
         })
-        .sortBy("score")
+        .sortBy('score')
-        .pluck("locale")
+        .pluck('locale')
         .last()
         .value();
     return language || lang;

lib/utils/page.js

@@ -1,31 +1,32 @@
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
-var url = require("url");
+var url = require('url');
-var path = require("path");
+var path = require('path');
-var cheerio = require("cheerio");
+var cheerio = require('cheerio');
-var domSerializer = require("dom-serializer");
+var domSerializer = require('dom-serializer');
-var request = require("request");
+var request = require('request');
-var crc = require("crc");
+var crc = require('crc');
+var slug = require('github-slugid');
 
-var links = require("./links");
+var links = require('./links');
-var imgUtils = require("./images");
+var imgUtils = require('./images');
-var fs = require("./fs");
+var fs = require('./fs');
-var batch = require("./batch");
+var batch = require('./batch');
 
-var parsableExtensions = require("gitbook-parsers").extensions;
+var parsableExtensions = require('gitbook-parsers').extensions;
+
+// Map of images that have been converted
+var imgConversionCache = {};
 
 // Render a cheerio dom as html
-var renderDom = function($, dom, options) {
+function renderDom($, dom, options) {
     if (!dom && $._root && $._root.children) {
         dom = $._root.children;
     }
 
     options = options|| dom.options || $._options;
     return domSerializer(dom, options);
-};
+}
-
-// Map of images that have been converted
-var imgConversionCache = {};
 
 function replaceText($, el, search, replace, text_only ) {
     return $(el).each(function(){
@@ -59,7 +60,7 @@ function replaceText($, el, search, replace, text_only ) {
                             // robust way.
                             $(node).before( new_val );
 
-                            // Don"t remove the node yet, or the loop will lose its place.
+                            // 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
@@ -79,7 +80,7 @@ function replaceText($, el, search, replace, text_only ) {
 }
 
 function pregQuote( str ) {
-    return (str+"").replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, "\\$1");
+    return (str+'').replace(/([\\\.\+\*\?\[\^\]\$\(\)\{\}\=\!\<\>\|\:])/g, '\\$1');
 }
 
 
@@ -101,23 +102,30 @@ function normalizeHtml(src, options) {
 
     // Find svg images to extract and process
     if (options.convertImages) {
-        $("svg").each(function() {
+        $('svg').each(function() {
             var content = renderDom($, $(this));
-            var svgId = _.uniqueId("svg");
+            var svgId = _.uniqueId('svg');
-            var dest = svgId+".svg";
+            var dest = svgId+'.svg';
 
             // Generate filename
-            dest = "/"+fs.getUniqueFilename(outputRoot, dest);
+            dest = '/'+fs.getUniqueFilename(outputRoot, dest);
 
-            svgContent[dest] = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"+content;
+            svgContent[dest] = '<?xml version="1.0" encoding="UTF-8"?>'+content;
-            $(this).replaceWith($("<img>").attr("src", dest));
+            $(this).replaceWith($('<img>').attr('src', dest));
         });
     }
 
+    // Generate ID for headings
+    $('h1,h2,h3,h4,h5,h6').each(function() {
+        if ($(this).attr('id')) return;
+
+        $(this).attr('id', slug($(this).text()));
+    });
+
     // Find images to normalize
-    $("img").each(function() {
+    $('img').each(function() {
         var origin;
-        var src = $(this).attr("src");
+        var src = $(this).attr('src');
 
         if (!src) return;
         var isExternal = links.isExternal(src);
@@ -132,13 +140,13 @@ function normalizeHtml(src, options) {
             // If image is external and ebook, then downlaod the images
             if (isExternal) {
                 origin = src;
-                src = "/"+crc.crc32(origin).toString(16)+path.extname(origin);
+                src = '/'+crc.crc32(origin).toString(16)+path.extname(url.parse(origin).pathname);
                 src = links.toAbsolute(src, options.base, options.output);
                 isExternal = false;
             }
 
             var ext = path.extname(src);
-            var srcAbs = links.join("/", options.base, src);
+            var srcAbs = links.join('/', options.base, src);
 
             // Test image extension
             if (_.contains(imgUtils.INVALID, ext)) {
@@ -147,29 +155,29 @@ function normalizeHtml(src, options) {
                     src = imgConversionCache[outputRoot][srcAbs];
                 } else {
                     // Not converted yet
-                    var dest = "";
+                    var dest = '';
 
                     // Replace extension
-                    dest = links.join(path.dirname(srcAbs), path.basename(srcAbs, ext)+".png");
+                    dest = links.join(path.dirname(srcAbs), path.basename(srcAbs, ext)+'.png');
-                    dest = dest[0] == "/"? dest.slice(1) : dest;
+                    dest = dest[0] == '/'? dest.slice(1) : dest;
 
-                    // Get a name that doesn"t exists
+                    // Get a name that doesn't exists
                     dest = fs.getUniqueFilename(outputRoot, dest);
 
-                    options.book.log.debug.ln("detect invalid image (will be converted to png):", srcAbs);
+                    options.book.log.debug.ln('detect invalid image (will be converted to png):', srcAbs);
 
                     // Add to cache
-                    imgConversionCache[outputRoot][srcAbs] = "/"+dest;
+                    imgConversionCache[outputRoot][srcAbs] = '/'+dest;
 
                     // Push to convert
                     toConvert.push({
                         origin: origin,
                         content: svgContent[srcAbs],
-                        source: isExternal? srcAbs : path.join("./", srcAbs),
+                        source: isExternal? srcAbs : path.join('./', srcAbs),
-                        dest: path.join("./", dest)
+                        dest: path.join('./', dest)
                     });
 
-                    src = links.join("/", dest);
+                    src = links.join('/', dest);
                 }
 
                 // Reset as relative to output
@@ -180,17 +188,17 @@ function normalizeHtml(src, options) {
                 // Need to downlaod image
                 toConvert.push({
                     origin: origin,
-                    source: path.join("./", srcAbs)
+                    source: path.join('./', srcAbs)
                 });
             }
         }
 
-        $(this).attr("src", src);
+        $(this).attr('src', src);
     });
 
     // Normalize links
-    $("a").each(function() {
+    $('a').each(function() {
-        var href = $(this).attr("href");
+        var href = $(this).attr('href');
         if (!href) return;
 
         if (links.isAnchor(href)) {
@@ -198,7 +206,7 @@ function normalizeHtml(src, options) {
         } else if (links.isRelative(href)) {
             var parts = url.parse(href);
             var absolutePath = links.join(options.base, parts.pathname);
-            var anchor = parts.hash || "";
+            var anchor = parts.hash || '';
 
 
             // If is in navigation relative: transform as content
@@ -209,33 +217,33 @@ function normalizeHtml(src, options) {
             // If md/adoc/rst files is not in summary
             // or for ebook, signal all files that are outside the summary
             else if (_.contains(parsableExtensions, path.extname(absolutePath)) ||
-            _.contains(["epub", "pdf", "mobi"], options.book.options.generator)) {
+            _.contains(['epub', 'pdf', 'mobi'], options.book.options.generator)) {
-                options.book.log.warn.ln("page", options.input, "contains an hyperlink to resource outside spine \""+href+"\"");
+                options.book.log.warn.ln('page', options.input, 'contains an hyperlink to resource outside spine \''+href+'\'');
             }
 
             // Transform as absolute
-            href = links.toAbsolute("/"+absolutePath, options.base, options.output)+anchor;
+            href = links.toAbsolute('/'+absolutePath, options.base, options.output)+anchor;
         } else {
             // External links
-            $(this).attr("target", "_blank");
+            $(this).attr('target', '_blank');
         }
 
         // Transform extension
-        $(this).attr("href", href);
+        $(this).attr('href', href);
     });
 
     // Highlight code blocks
-    $("code").each(function() {
+    $('code').each(function() {
         // Normalize language
         var lang = _.chain(
-                ($(this).attr("class") || "").split(" ")
+                ($(this).attr('class') || '').split(' ')
             )
             .map(function(cl) {
                 // Markdown
-                if (cl.search("lang-") === 0) return cl.slice("lang-".length);
+                if (cl.search('lang-') === 0) return cl.slice('lang-'.length);
 
                 // Asciidoc
-                if (cl.search("language-") === 0) return cl.slice("language-".length);
+                if (cl.search('language-') === 0) return cl.slice('language-'.length);
 
                 return null;
             })
@@ -244,7 +252,7 @@ function normalizeHtml(src, options) {
             .value();
 
         var source = $(this).text();
-        var blk = options.book.template.applyBlock("code", {
+        var blk = options.book.template.applyBlock('code', {
             body: source,
             kwargs: {
                 language: lang
@@ -261,12 +269,12 @@ function normalizeHtml(src, options) {
     });
 
     _.each(glossary, function(term) {
-        var r =  new RegExp( "\\b(" + pregQuote(term.name.toLowerCase()) + ")\\b" , "gi" );
+        var r =  new RegExp( '\\b(' + pregQuote(term.name.toLowerCase()) + ')\\b' , 'gi' );
         var includedInFiles = false;
 
-        $("*").each(function() {
+        $('*').each(function() {
             // Ignore codeblocks
-            if (_.contains(["code", "pre", "a"], this.name.toLowerCase())) return;
+            if (_.contains(['code', 'pre', 'a'], this.name.toLowerCase())) return;
 
             replaceText($, this, r, function(match) {
                 // Add to files index in glossary
@@ -275,7 +283,7 @@ function normalizeHtml(src, options) {
                     term.files = term.files || [];
                     term.files.push(options.navigation[options.input]);
                 }
-                return "<a href=\""+links.toAbsolute("/GLOSSARY.html", options.base, options.output) + "#" + term.id+"\" class=\"glossary-term\" title=\""+_.escape(term.description)+"\">"+match+"</a>";
+                return '<a href=\''+links.toAbsolute('/GLOSSARY.html', options.base, options.output) + '#' + term.id+'\' class=\'glossary-term\' title=\''+_.escape(term.description)+'\'>'+match+'</a>';
             });
         });
     });
@@ -291,7 +299,7 @@ function convertImages(images, options) {
     if (!options.convertImages) return Q();
 
     var downloaded = [];
-    options.book.log.debug.ln("convert ", images.length, "images to png");
+    options.book.log.debug.ln('convert ', images.length, 'images to png');
 
     return batch.execEach(images, {
         max: 100,
@@ -303,13 +311,13 @@ function convertImages(images, options) {
             // Write image if need to be download
             .then(function() {
                 if (!image.origin && !_.contains(downloaded, image.origin)) return;
-                options.book.log.debug("download image", image.origin, "...");
+                options.book.log.debug('download image', image.origin, '...');
                 downloaded.push(image.origin);
                 return options.book.log.debug.promise(fs.writeStream(imgin, request(image.origin)))
                 .fail(function(err) {
                     if (!_.isError(err)) err = new Error(err);
 
-                    err.message = "Fail downloading "+image.origin+": "+err.message;
+                    err.message = 'Fail downloading '+image.origin+': '+err.message;
                     throw err;
                 });
             })
@@ -324,13 +332,13 @@ function convertImages(images, options) {
             .then(function() {
                 if (!image.dest) return;
                 var imgout = path.resolve(options.book.options.output, image.dest);
-                options.book.log.debug("convert image", image.source, "to", image.dest, "...");
+                options.book.log.debug('convert image', image.source, 'to', image.dest, '...');
                 return options.book.log.debug.promise(imgUtils.convertSVG(imgin, imgout));
             });
         }
     })
     .then(function() {
-        options.book.log.debug.ok(images.length+" images converted with success");
+        options.book.log.debug.ok(images.length+' images converted with success');
     });
 }
 
@@ -344,16 +352,16 @@ function normalizePage(sections, options) {
         convertImages: false,
 
         // Current file path
-        input: ".",
+        input: '.',
 
         // Navigation to use to transform path
         navigation: {},
 
         // Directory parent of the file currently in rendering process
-        base: "./",
+        base: './',
 
         // Directory parent from the html output
-        output: "./",
+        output: './',
 
         // Glossary terms
         glossary: []
@@ -363,7 +371,7 @@ function normalizePage(sections, options) {
     var toConvert = [];
 
     sections = _.map(sections, function(section) {
-        if (section.type != "normal") return section;
+        if (section.type != 'normal') return section;
 
         var out = normalizeHtml(section.content, options);
 
@@ -374,27 +382,13 @@ function normalizePage(sections, options) {
 
     return Q()
     .then(function() {
-        toConvert = _.uniq(toConvert, "source");
+        toConvert = _.uniq(toConvert, 'source');
         return convertImages(toConvert, options);
     })
     .thenResolve(sections);
 }
 
-// Extract text from sections
-function extractText(sections) {
-    return _.reduce(sections, function(prev, section) {
-        if (section.type != "normal") return prev;
-
-        var $ = cheerio.load(section.content);
-        $("*").each(function() {
-            prev = prev+" "+$(this).text();
-        });
-
-        return prev;
-    }, "");
-}
 
 module.exports = {
-    normalize: normalizePage,
+    normalize: normalizePage
-    extractText: extractText
 };

lib/utils/progress.js

@@ -1,4 +1,4 @@
-var _ = require("lodash");
+var _ = require('lodash');
 
 // Returns from a navigation and a current file, a snapshot of current detailed state
 function calculProgress(navigation, current) {

lib/version.js

@@ -0,0 +1,19 @@
+var semver = require('semver');
+var pkg = require('../package.json');
+
+var VERSION = pkg.version;
+var VERSION_STABLE = VERSION.replace(/\-(\S+)/g, '');
+
+// Test if current current gitbook version satisfies a condition
+// We can't directly use samver.satisfies since it will break all plugins when gitbook version is a prerelease (beta, alpha)
+function satisfies(condition) {
+    // Test with real version
+    if (semver.satisfies(VERSION, condition)) return true;
+
+    // Test with future stable release
+    return semver.satisfies(VERSION_STABLE, condition);
+}
+
+module.exports = {
+    satisfies: satisfies
+};

package.json

@@ -1,20 +1,22 @@
 {
     "name": "gitbook",
-    "version": "2.4.2",
+    "version": "2.6.2",
     "homepage": "https://www.gitbook.com",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
     "dependencies": {
         "q": "1.0.1",
-        "lunr": "0.5.12",
         "lodash": "3.10.1",
         "graceful-fs": "3.0.5",
         "resolve": "0.6.3",
         "fs-extra": "0.16.5",
         "fstream-ignore": "1.0.2",
-        "gitbook-parsers": "0.8.2",
+        "gitbook-parsers": "0.8.7",
         "gitbook-plugin-highlight": "1.0.3",
-        "nunjucks": "mozilla/nunjucks#dc89bf91611a2101731c2c06afcf5c32160b4dc9",
+        "gitbook-plugin-sharing": "1.0.1",
+        "gitbook-plugin-search": "1.1.0",
+        "gitbook-plugin-fontsettings": "1.0.2",
+        "nunjucks": "2.2.0",
         "nunjucks-autoescape": "1.0.0",
         "nunjucks-filter": "1.0.0",
         "i18n": "0.5.0",
@@ -24,26 +26,39 @@
         "gitbook-plugin-livereload": "0.0.1",
         "chokidar": "~1.0.5",
         "send": "0.2.0",
-        "tiny-lr": "0.1.5",
+        "tiny-lr": "0.2.1",
         "tmp": "0.0.24",
         "crc": "3.2.1",
         "bash-color": "0.0.3",
-        "URIjs": "1.14.1",
+        "urijs": "1.17.0",
         "request": "2.51.0",
         "npm": "2.4.1",
         "dom-serializer": "0.1.0",
         "spawn-cmd": "0.0.2",
-        "escape-string-regexp": "1.0.3"
+        "escape-string-regexp": "1.0.3",
+        "juice": "1.5.0",
+        "jsonschema": "1.0.2",
+        "json-schema-defaults": "0.1.1",
+        "merge-defaults": "0.2.1",
+        "github-slugid": "1.0.0"
     },
     "devDependencies": {
+        "eslint": "1.5.0",
         "mocha": "2.3.2",
         "should": "7.1.0",
-        "grunt": "~0.4.2",
+        "should-promised": "0.3.1",
-        "grunt-cli": "0.1.11",
+        "gulp": "^3.8.11",
-        "grunt-contrib-copy": "0.5.0",
+        "gulp-rename": "^1.2.2",
-        "grunt-contrib-less": "~0.5.0",
+        "gulp-uglify": "1.1.0",
-        "grunt-contrib-requirejs": "0.4.1",
+        "gulp-less": "3.0.2",
-        "grunt-bower-install-simple": "0.9.2"
+        "gulp-minify-css": "1.0.0",
+        "gulp-util": "3.0.6",
+        "browserify": "11.0.1",
+        "merge-stream": "0.1.7",
+        "vinyl-source-stream": "1.1.0",
+        "jquery": "2.1.4",
+        "mousetrap": "1.5.3",
+        "font-awesome": "4.1.0"
     },
     "scripts": {
         "test": "node_modules/.bin/mocha --reporter spec --timeout 15000"

test/assertions.js

@@ -1,27 +1,29 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var fs = require("fs");
+var fs = require('fs');
-var path = require("path");
+var path = require('path');
-var should = require("should");
+var should = require('should');
-var cheerio = require("cheerio");
+var cheerio = require('cheerio');
 
-should.Assertion.add("file", function(file, description) {
+require('should-promised');
-    this.params = { actual: this.obj.toString(), operator: "have file " + file, message: description };
 
-    this.obj.should.have.property("options").which.is.an.Object();
+should.Assertion.add('file', function(file, description) {
-    this.obj.options.should.have.property("output").which.is.a.String();
+    this.params = { actual: this.obj.toString(), operator: 'have file ' + file, message: description };
+
+    this.obj.should.have.property('options').which.is.an.Object();
+    this.obj.options.should.have.property('output').which.is.a.String();
     this.assert(fs.existsSync(path.resolve(this.obj.options.output, file)));
 });
 
-should.Assertion.add("jsonfile", function(file, description) {
+should.Assertion.add('jsonfile', function(file, description) {
-    this.params = { actual: this.obj.toString(), operator: "have valid jsonfile " + file, message: description };
+    this.params = { actual: this.obj.toString(), operator: 'have valid jsonfile ' + file, message: description };
 
-    this.obj.should.have.property("options").which.is.an.Object();
+    this.obj.should.have.property('options').which.is.an.Object();
-    this.obj.options.should.have.property("output").which.is.a.String();
+    this.obj.options.should.have.property('output').which.is.a.String();
-    this.assert(JSON.parse(fs.readFileSync(path.resolve(this.obj.options.output, file), { encoding: "utf-8" })));
+    this.assert(JSON.parse(fs.readFileSync(path.resolve(this.obj.options.output, file), { encoding: 'utf-8' })));
 });
 
-should.Assertion.add("html", function(rules, description) {
+should.Assertion.add('html', function(rules, description) {
-    this.params = { actual: "HTML string", operator: "valid html", message: description };
+    this.params = { actual: 'HTML string', operator: 'valid html', message: description };
     var $ = cheerio.load(this.obj);
 
     _.each(rules, function(validations, query) {

test/books/conrefs/README.md

@@ -1,5 +1,8 @@
 # Readme
 
+<p id="test-plugin-block-shortcuts-1">$$test_block1$$</p>
+<p id="test-plugin-block-shortcuts-2">{% include "./block.md" %}</p>
+
 ### Relative
 
 <p id="t1">{% include "./hello.md" %}</p>

test/books/conrefs/block.md

@@ -0,0 +1 @@
+$$test_block2$$

test/books/headings/README.md

@@ -0,0 +1,3 @@
+# Hello World
+
+## Hello {#hello-custom}

test/books/structure/README.adoc

@@ -0,0 +1 @@
+== Readme for the bookk

test/books/structure/README.md

@@ -0,0 +1 @@
+# Readme for GitHub

test/books/structure/SUMMARY.md

@@ -0,0 +1 @@
+# Summary

test/books/structure/book.json

@@ -0,0 +1,5 @@
+{
+    "structure": {
+        "readme": "README.adoc"
+    }
+}

test/books/structure/glossary.md

@@ -0,0 +1,5 @@
+# Glossary
+
+### Hello
+
+Hello world

test/codehighlighting.js

@@ -1,63 +1,63 @@
-var path = require("path");
+var path = require('path');
-var fs = require("fs");
+var fs = require('fs');
 
-var Plugin = require("../lib/plugin");
+var Plugin = require('../lib/plugin');
-var PLUGINS_ROOT = path.resolve(__dirname, "plugins");
+var PLUGINS_ROOT = path.resolve(__dirname, 'plugins');
 
-describe("Code Highlighting", function () {
+describe('Code Highlighting', function () {
     var book, PAGE;
 
     before(function() {
-        return books.generate("highlight", "website", {
+        return books.generate('highlight', 'website', {
             prepare: function(_book) {
                 book = _book;
 
-                var plugin = new Plugin(book, "replace_highlight");
+                var plugin = new Plugin(book, 'replace_highlight');
-                plugin.load("./replace_highlight", PLUGINS_ROOT);
+                plugin.load('./replace_highlight', PLUGINS_ROOT);
 
                 book.plugins.load(plugin);
             }
         })
         .then(function() {
             PAGE = fs.readFileSync(
-                path.join(book.options.output, "index.html"),
+                path.join(book.options.output, 'index.html'),
-                { encoding: "utf-8" }
+                { encoding: 'utf-8' }
             );
         });
     });
 
-    it("should correctly replace highlighting", function() {
+    it('should correctly replace highlighting', function() {
         PAGE.should.be.html({
-            "code": {
+            'code': {
                 index: 0,
-                text: "code_test 1\n_code"
+                text: 'code_test 1\n_code'
             }
         });
     });
 
-    it("should correctly replace highlighting with language", function() {
+    it('should correctly replace highlighting with language', function() {
         PAGE.should.be.html({
-            "code": {
+            'code': {
                 index: 1,
-                text: "lang_test 2\n_lang"
+                text: 'lang_test 2\n_lang'
             }
         });
     });
 
-    it("should correctly replace highlighting for inline code", function() {
+    it('should correctly replace highlighting for inline code', function() {
         PAGE.should.be.html({
-            "code": {
+            'code': {
                 index: 2,
-                text: "code_test 3_code"
+                text: 'code_test 3_code'
             }
         });
     });
 
-    it("should correctly replace highlighting for inline code with html tags", function() {
+    it('should correctly replace highlighting for inline code with html tags', function() {
         PAGE.should.be.html({
-            "code": {
+            'code': {
                 index: 3,
-                text: "code_<test>_code"
+                text: 'code_<test>_code'
             }
         });
     });

test/configuration.js

@@ -1,37 +1,37 @@
-describe("Configuration", function () {
+describe('Configuration', function () {
-    it("should extract default title from README", function() {
+    it('should extract default title from README', function() {
-        return books.parse("basic")
+        return books.parse('basic')
             .then(function(book) {
-                book.options.title.should.be.equal("Readme");
+                book.options.title.should.be.equal('Readme');
             });
     });
 
-    it("should extract default description from README", function() {
+    it('should extract default description from README', function() {
-        return books.parse("basic")
+        return books.parse('basic')
             .then(function(book) {
-                book.options.description.should.be.equal("Default description for the book.");
+                book.options.description.should.be.equal('Default description for the book.');
             });
     });
 
-    it("should correctly load from json (book.json)", function() {
+    it('should correctly load from json (book.json)', function() {
-        return books.parse("config-json")
+        return books.parse('config-json')
             .then(function(book) {
-                book.options.title.should.be.equal("json-config");
+                book.options.title.should.be.equal('json-config');
             });
     });
 
-    it("should correctly load from JavaScript (book.js)", function() {
+    it('should correctly load from JavaScript (book.js)', function() {
-        return books.parse("config-js")
+        return books.parse('config-js')
             .then(function(book) {
-                book.options.title.should.be.equal("js-config");
+                book.options.title.should.be.equal('js-config');
             });
     });
 
-    it("should provide configuration on book.config.get", function() {
+    it('should provide configuration on book.config.get', function() {
-        return books.parse("basic")
+        return books.parse('basic')
             .then(function(book) {
-                book.config.get("description").should.be.equal("Default description for the book.");
+                book.config.get('description').should.be.equal('Default description for the book.');
-                book.getConfig("description").should.be.equal("Default description for the book.");
+                book.getConfig('description').should.be.equal('Default description for the book.');
             });
     });
 });

test/conrefs.js

@@ -1,66 +1,66 @@
-var fs = require("fs");
+var fs = require('fs');
-var path = require("path");
+var path = require('path');
 
-describe("ConRefs", function () {
+describe('ConRefs', function () {
     var book, readme;
 
     before(function() {
-        return books.generate("conrefs", "website")
+        return books.generate('conrefs', 'website')
             .then(function(_book) {
                 book = _book;
 
                 readme = fs.readFileSync(
-                    path.join(book.options.output, "index.html"),
+                    path.join(book.options.output, 'index.html'),
-                    { encoding: "utf-8" }
+                    { encoding: 'utf-8' }
                 );
             });
     });
 
-    it("should handle local references", function() {
+    it('should handle local references', function() {
         readme.should.be.html({
-            ".page-inner p#t1": {
+            '.page-inner p#t1': {
                 count: 1,
-                text: "Hello World",
+                text: 'Hello World',
                 trim: true
             }
         });
     });
 
-    it("should handle local references with absolute paths", function() {
+    it('should handle local references with absolute paths', function() {
         readme.should.be.html({
-            ".page-inner p#t2": {
+            '.page-inner p#t2': {
                 count: 1,
-                text: "Hello World",
+                text: 'Hello World',
                 trim: true
             }
         });
     });
 
-    it("should correctly include file from git reference", function() {
+    it('should correctly include file from git reference', function() {
         readme.should.be.html({
-            ".page-inner p#t3": {
+            '.page-inner p#t3': {
                 count: 1,
-                text: "Hello from git",
+                text: 'Hello from git',
                 trim: true
             }
         });
     });
 
-    it("should correctly handle deep include in git reference", function() {
+    it('should correctly handle deep include in git reference', function() {
         readme.should.be.html({
-            ".page-inner p#t4": {
+            '.page-inner p#t4': {
                 count: 1,
-                text: "First Hello. Hello from git",
+                text: 'First Hello. Hello from git',
                 trim: true
             }
         });
     });
 
-    it("should correctly handle absolute include in git reference", function() {
+    it('should correctly handle absolute include in git reference', function() {
         readme.should.be.html({
-            ".page-inner p#t5": {
+            '.page-inner p#t5': {
                 count: 1,
-                text: "First Hello. Hello from git",
+                text: 'First Hello. Hello from git',
                 trim: true
             }
         });

test/ebook.js

@@ -1,66 +1,70 @@
-var fs = require("fs");
+var fs = require('fs');
-var path = require("path");
+var path = require('path');
 
-describe("eBook generator", function () {
+describe('eBook generator', function () {
-    describe("Basic Book", function() {
+    describe('Basic Book', function() {
         var book;
 
         before(function() {
-            return books.generate("basic", "ebook")
+            return books.generate('basic', 'ebook')
                 .then(function(_book) {
                     book = _book;
                 });
         });
 
-        it("should correctly output a SUMMARY.html", function() {
+        it('should correctly output a SUMMARY.html', function() {
-            book.should.have.file("SUMMARY.html");
+            book.should.have.file('SUMMARY.html');
         });
 
-        it("should correctly copy assets", function() {
+        it('should correctly copy assets', function() {
-            book.should.have.file("gitbook");
+            book.should.have.file('gitbook');
-            book.should.have.file("gitbook/style.css");
+            book.should.have.file('gitbook/ebook.css');
+        });
+
+        it('should not copy website assets', function() {
+            book.should.not.have.file('gitbook/style.css');
         });
     });
 
-    describe("Custom styles", function() {
+    describe('Custom styles', function() {
         var book;
 
         before(function() {
-            return books.generate("style-print", "ebook")
+            return books.generate('style-print', 'ebook')
                 .then(function(_book) {
                     book = _book;
                 });
         });
 
-        it("should remove default print.css", function() {
+        it('should remove default print.css', function() {
             var PAGE = fs.readFileSync(
-                path.join(book.options.output, "index.html"),
+                path.join(book.options.output, 'index.html'),
-                { encoding: "utf-8" }
+                { encoding: 'utf-8' }
             );
 
             // There are 2 styles (one from plugin-highlight and the new style)
             PAGE.should.be.html({
-                "link": {
+                'link': {
                     count: 2
                 }
             });
 
             PAGE.should.be.html({
-                "link[href=\"./styles/print.css\"]": {
+                'link[href=\'./styles/print.css\']': {
                     count: 1
                 }
             });
 
             PAGE.should.be.html({
-                "link[href=\"gitbook/plugins/gitbook-plugin-highlight/ebook.css\"]": {
+                'link[href="gitbook/plugins/gitbook-plugin-highlight/ebook.css"]': {
                     count: 1
                 }
             });
         });
 
-        it("should correctly print.css", function() {
+        it('should correctly copy print.css', function() {
-            book.should.have.file("styles");
+            book.should.have.file('styles');
-            book.should.have.file("styles/print.css");
+            book.should.have.file('styles/print.css');
         });
     });
 });

test/format.js

@@ -0,0 +1,11 @@
+describe('Formatting', function () {
+    it('should provide formatting with book.formatString', function() {
+        return books.parse('basic')
+        .then(function(book) {
+            return book.formatString('markdown', 'this is a **test**');
+        })
+        .then(function(content) {
+            content.should.equal('<p>this is a <strong>test</strong></p>\n');
+        });
+    });
+});

test/heading.js

@@ -0,0 +1,37 @@
+var path = require('path');
+var fs = require('fs');
+
+describe('Headings', function () {
+    var book, PAGE;
+
+    before(function() {
+        return books.generate('headings', 'website')
+        .then(function(_book) {
+            book = _book;
+
+            PAGE = fs.readFileSync(
+                path.join(book.options.output, 'index.html'),
+                { encoding: 'utf-8' }
+            );
+        });
+    });
+
+    describe('IDs', function() {
+        it('should correctly generate an ID', function() {
+            PAGE.should.be.html({
+                'h1#hello-world': {
+                    count: 1
+                }
+            });
+        });
+
+        it('should correctly accept custom ID', function() {
+            PAGE.should.be.html({
+                'h2#hello-custom': {
+                    count: 1
+                }
+            });
+        });
+    });
+});
+

test/helper.js

@@ -1,13 +1,13 @@
-var os = require("os");
+var os = require('os');
-var path = require("path");
+var path = require('path');
-var Q = require("q");
+var Q = require('q');
-var _ = require("lodash");
+var _ = require('lodash');
 
-var fsUtil = require("../lib/utils/fs");
+var fsUtil = require('../lib/utils/fs');
-var Book = require("../").Book;
+var Book = require('../').Book;
-var LOG_LEVELS = require("../").LOG_LEVELS;
+var LOG_LEVELS = require('../').LOG_LEVELS;
 
-require("./assertions");
+require('./assertions');
 
 
 var BOOKS = {};
@@ -20,7 +20,7 @@ function generateBook(bookId, test, opts) {
         prepare: function() {}
     });
 
-    return parseBook(bookId, test)
+    return parseBook(bookId, test, opts)
     .then(function(book) {
 
         return Q(opts.prepare(book))
@@ -32,21 +32,27 @@ function generateBook(bookId, test, opts) {
 }
 
 // Generate and return a book
-function parseBook(bookId, test) {
+function parseBook(bookId, test, opts) {
-    test = test || "website";
+    opts = _.defaults(opts || {}, {
-    BOOKS[bookId] = BOOKS[bookId] || {};
+        testId: ''
-    if (BOOKS[bookId][test]) return Q(BOOKS[bookId][test]);
+    });
 
-    BOOKS[bookId][test] = new Book(path.resolve(__dirname, "books", bookId), {
+    test = test || 'website';
+    var testId = [test, opts.testId].join('-');
+
+    BOOKS[bookId] = BOOKS[bookId] || {};
+    if (BOOKS[bookId][testId]) return Q(BOOKS[bookId][testId]);
+
+    BOOKS[bookId][testId] = new Book(path.resolve(__dirname, 'books', bookId), {
         logLevel: LOG_LEVELS.DISABLED,
         config: {
-            output: path.resolve(TMPDIR, bookId+"-"+test)
+            output: path.resolve(TMPDIR, bookId+'-'+testId)
         }
     });
 
-    return BOOKS[bookId][test].parse()
+    return BOOKS[bookId][testId].parse()
     .then(function() {
-        return BOOKS[bookId][test];
+        return BOOKS[bookId][testId];
     });
 }
 

test/init.js

@@ -1,24 +1,24 @@
-var fs = require("fs");
+var fs = require('fs');
-var path = require("path");
+var path = require('path');
-var should = require("should");
+var should = require('should');
 
-var Book = require("../").Book;
+var Book = require('../').Book;
-var LOG_LEVELS = require("../").LOG_LEVELS;
+var LOG_LEVELS = require('../').LOG_LEVELS;
 
-describe("Init Books", function () {
+describe('Init Books', function () {
     var initRoot;
 
     before(function() {
-        initRoot = path.resolve(__dirname, "books/init");
+        initRoot = path.resolve(__dirname, 'books/init');
         return Book.init(initRoot, {
-            logLevel: LOG_LEVELS.DISABLED,
+            logLevel: LOG_LEVELS.DISABLED
         });
     });
 
-    it("should create all chapters", function() {
+    it('should create all chapters', function() {
-        should(fs.existsSync(path.resolve(initRoot, "hello.md"))).be.ok();
+        should(fs.existsSync(path.resolve(initRoot, 'hello.md'))).be.ok();
-        should(fs.existsSync(path.resolve(initRoot, "hello2.md"))).be.ok();
+        should(fs.existsSync(path.resolve(initRoot, 'hello2.md'))).be.ok();
-        should(fs.existsSync(path.resolve(initRoot, "hello3/hello4.md"))).be.ok();
+        should(fs.existsSync(path.resolve(initRoot, 'hello3/hello4.md'))).be.ok();
-        should(fs.existsSync(path.resolve(initRoot, "hello3/hello5/hello6.md"))).be.ok();
+        should(fs.existsSync(path.resolve(initRoot, 'hello3/hello5/hello6.md'))).be.ok();
     });
 });

test/json.js

@@ -1,91 +1,91 @@
-var fs = require("fs");
+var fs = require('fs');
-var path = require("path");
+var path = require('path');
 
-describe("JSON generator", function () {
+describe('JSON generator', function () {
-    describe("Basic Book", function() {
+    describe('Basic Book', function() {
         var book;
 
         before(function() {
-            return books.generate("basic", "json")
+            return books.generate('basic', 'json')
                 .then(function(_book) {
                     book = _book;
                 });
         });
 
-        it("should correctly output a README.json", function() {
+        it('should correctly output a README.json', function() {
-            book.should.have.file("README.json");
+            book.should.have.file('README.json');
         });
 
-        it("should output a valid json", function() {
+        it('should output a valid json', function() {
-            book.should.have.jsonfile("README.json");
+            book.should.have.jsonfile('README.json');
         });
 
-        describe("Page Format", function() {
+        describe('Page Format', function() {
             var page;
 
             before(function() {
                 page = JSON.parse(
                     fs.readFileSync(
-                        path.join(book.options.output, "README.json"),
+                        path.join(book.options.output, 'README.json'),
-                        { encoding: "utf-8" }
+                        { encoding: 'utf-8' }
                     )
                 );
             });
 
-            it("should contains valid section", function() {
+            it('should contains valid section', function() {
-                page.should.have.property("sections").with.lengthOf(1);
+                page.should.have.property('sections').with.lengthOf(1);
-                page.sections[0].should.have.property("content").which.is.a.String();
+                page.sections[0].should.have.property('content').which.is.a.String();
-                page.sections[0].should.have.property("type", "normal");
+                page.sections[0].should.have.property('type', 'normal');
             });
 
-            it("should contains valid progress", function() {
+            it('should contains valid progress', function() {
-                page.should.have.property("progress");
+                page.should.have.property('progress');
-                page.progress.should.have.property("chapters").with.lengthOf(1);
+                page.progress.should.have.property('chapters').with.lengthOf(1);
-                page.progress.should.have.property("current");
+                page.progress.should.have.property('current');
             });
 
-            it("should contains no languages", function() {
+            it('should contains no languages', function() {
-                page.should.have.property("langs").with.lengthOf(0);
+                page.should.have.property('langs').with.lengthOf(0);
             });
         });
     });
 
-    describe("Multilingual Book", function() {
+    describe('Multilingual Book', function() {
         var book;
 
         before(function() {
-            return books.generate("languages", "json")
+            return books.generate('languages', 'json')
                 .then(function(_book) {
                     book = _book;
                 });
         });
 
-        it("should correctly output READMEs", function() {
+        it('should correctly output READMEs', function() {
-            book.should.have.file("README.json");
+            book.should.have.file('README.json');
-            book.should.have.file("en/README.json");
+            book.should.have.file('en/README.json');
-            book.should.have.file("fr/README.json");
+            book.should.have.file('fr/README.json');
         });
 
-        it("should output valid json", function() {
+        it('should output valid json', function() {
-            book.should.have.jsonfile("README.json");
+            book.should.have.jsonfile('README.json');
-            book.should.have.jsonfile("en/README.json");
+            book.should.have.jsonfile('en/README.json');
-            book.should.have.jsonfile("fr/README.json");
+            book.should.have.jsonfile('fr/README.json');
         });
 
-        describe("Page Format", function() {
+        describe('Page Format', function() {
             var page;
 
             before(function() {
                 page = JSON.parse(
                     fs.readFileSync(
-                        path.join(book.options.output, "README.json"),
+                        path.join(book.options.output, 'README.json'),
-                        { encoding: "utf-8" }
+                        { encoding: 'utf-8' }
                     )
                 );
             });
 
-            it("should contains no languages", function() {
+            it('should contains no languages', function() {
-                page.should.have.property("langs").with.lengthOf(2);
+                page.should.have.property('langs').with.lengthOf(2);
             });
         });
     });

test/plugins.js

@@ -1,47 +1,48 @@
-var _ = require("lodash");
+var _ = require('lodash');
-var should = require("should");
+var fs = require('fs');
-var path = require("path");
+var should = require('should');
+var path = require('path');
 
-var Plugin = require("../lib/plugin");
+var Plugin = require('../lib/plugin');
-var parsers = require("gitbook-parsers");
+var parsers = require('gitbook-parsers');
-var PLUGINS_ROOT = path.resolve(__dirname, "plugins");
+var PLUGINS_ROOT = path.resolve(__dirname, 'plugins');
 
-describe("Plugins", function () {
+describe('Plugins', function () {
     var book;
 
     before(function() {
-        return books.parse("basic")
+        return books.parse('basic')
-            .then(function(_book) {
+        .then(function(_book) {
-                book = _book;
+            book = _book;
-            });
+        });
     });
 
-    describe("Invalid", function() {
+    describe('Invalid', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "invalid");
+            plugin = new Plugin(book, 'invalid');
-            plugin.load("./invalid", PLUGINS_ROOT);
+            plugin.load('./invalid', PLUGINS_ROOT);
         });
 
-        it("should be detected", function() {
+        it('should be detected', function() {
             should(plugin.isValid()).be.exactly(false);
         });
     });
 
-    describe("Empty", function() {
+    describe('Empty', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "empty");
+            plugin = new Plugin(book, 'empty');
-            plugin.load("./empty", PLUGINS_ROOT);
+            plugin.load('./empty', PLUGINS_ROOT);
         });
 
-        it("should valid a plugin", function() {
+        it('should valid a plugin', function() {
             should(plugin.isValid()).be.exactly(true);
         });
 
-        it("should return an empty list of resources", function() {
+        it('should return an empty list of resources', function() {
             return plugin.getResources()
             .then(function(resources) {
                 _.each(Plugin.RESOURCES, function(resName) {
@@ -51,97 +52,128 @@ describe("Plugins", function () {
         });
     });
 
-    describe("Resources", function() {
+    describe('Configuration', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "resources");
+            plugin = new Plugin(book, 'testconfig');
-            plugin.load("./resources", PLUGINS_ROOT);
+            plugin.load('./config', PLUGINS_ROOT);
+        });
+
+        it('should throw error for invalid configuration', function() {
+            return plugin.validateConfig({})
+            .should.be.rejectedWith('Configuration Error: pluginsConfig.testconfig.testRequired is required');
+        });
+
+        it('should throw error for invalid types', function() {
+            return plugin.validateConfig({
+                testRequired: 'hello'
+            })
+            .should.be.rejectedWith('Configuration Error: pluginsConfig.testconfig.testRequired is not of a type(s) number');
+        });
+
+        it('should extend with default values', function() {
+            return plugin.validateConfig({
+                testRequired: 12
+            })
+            .should.be.fulfilledWith({
+                hello: 'world',
+                testRequired: 12
+            });
+        });
+    });
+
+    describe('Resources', function() {
+        var plugin;
+
+        before(function() {
+            plugin = new Plugin(book, 'resources');
+            plugin.load('./resources', PLUGINS_ROOT);
 
             return book.plugins.load(plugin);
         });
 
-        it("should valid a plugin", function() {
+        it('should valid a plugin', function() {
             should(plugin.isValid()).be.exactly(true);
         });
 
-        describe("Website", function() {
+        describe('Website', function() {
-            it("should return a valid list of resources", function() {
+            it('should return a valid list of resources', function() {
-                return plugin.getResources("website")
+                return plugin.getResources('website')
                     .then(function(resources) {
                         resources.js.should.have.lengthOf(1);
                     });
             });
 
-            it("should extend books plugins", function() {
+            it('should extend books plugins', function() {
-                var resources = book.plugins.resources("website");
+                var resources = book.plugins.resources('website');
-                resources.js.should.have.lengthOf(1);
+                resources.js.should.have.lengthOf(5);
             });
         });
 
-        describe("eBook", function() {
+        describe('eBook', function() {
-            it("should return a valid list of resources", function() {
+            it('should return a valid list of resources', function() {
-                return plugin.getResources("ebook")
+                return plugin.getResources('ebook')
                     .then(function(resources) {
                         resources.css.should.have.lengthOf(1);
                     });
             });
 
-            it("should extend books plugins", function() {
+            it('should extend books plugins', function() {
-                var resources = book.plugins.resources("ebook");
+                var resources = book.plugins.resources('ebook');
 
                 // There is resources from highlight plugin and this plugin
                 resources.css.should.have.lengthOf(2);
                 should.exist(_.find(resources.css, {
-                    path: "./resources/test"
+                    path: 'gitbook-plugin-resources/test'
                 }));
             });
         });
     });
 
-    describe("Filters", function() {
+    describe('Filters', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "filters");
+            plugin = new Plugin(book, 'filters');
-            plugin.load("./filters", PLUGINS_ROOT);
+            plugin.load('./filters', PLUGINS_ROOT);
 
             return book.plugins.load(plugin);
         });
 
-        it("should valid a plugin", function() {
+        it('should valid a plugin', function() {
             should(plugin.isValid()).be.exactly(true);
         });
 
-        it("should return a map of filters", function() {
+        it('should return a map of filters', function() {
             var filters = plugin.getFilters();
 
             _.size(filters).should.equal(2);
-            filters.should.have.property("hello");
+            filters.should.have.property('hello');
-            filters.should.have.property("helloCtx");
+            filters.should.have.property('helloCtx');
         });
 
-        it("should correctly extend template filters", function() {
+        it('should correctly extend template filters', function() {
-            return book.template.renderString("{{ \"World\"|hello }}")
+            return book.template.renderString('{{ \'World\'|hello }}')
                 .then(function(content) {
-                    content.should.equal("Hello World");
+                    content.should.equal('Hello World');
                 });
         });
 
-        it("should correctly set book as context", function() {
+        it('should correctly set book as context', function() {
-            return book.template.renderString("{{ \"root\"|helloCtx }}")
+            return book.template.renderString('{{ \'root\'|helloCtx }}')
                 .then(function(content) {
-                    content.should.equal("root:"+book.root);
+                    content.should.equal('root:'+book.root);
                 });
         });
     });
 
-    describe("Blocks", function() {
+    describe('Blocks', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "blocks");
+            plugin = new Plugin(book, 'blocks');
-            plugin.load("./blocks", PLUGINS_ROOT);
+            plugin.load('./blocks', PLUGINS_ROOT);
 
             return book.plugins.load(plugin);
         });
@@ -151,89 +183,123 @@ describe("Plugins", function () {
             .then(book.template.postProcess);
         };
 
-        it("should valid a plugin", function() {
+        it('should valid a plugin', function() {
             should(plugin.isValid()).be.exactly(true);
         });
 
-        it("should correctly extend template blocks", function() {
+        it('should correctly extend template blocks', function() {
-            return testTpl("{% test %}hello{% endtest %}")
+            return testTpl('{% test %}hello{% endtest %}')
                 .then(function(content) {
-                    content.should.equal("testhellotest");
+                    content.should.equal('testhellotest');
                 });
         });
 
-        it("should correctly accept shortcuts", function() {
+        describe('Shortcuts', function() {
-           return testTpl("$$hello$$", {}, {
+            it('should correctly accept shortcuts', function() {
-                    type: "markdown"
+                return testTpl('$$hello$$', {}, {
+                    type: 'markdown'
                 })
                 .then(function(content) {
-                    content.should.equal("testhellotest");
+                    content.should.equal('testhellotest');
+                });
+            });
+
+            it('should correctly apply shortcuts to included file', function() {
+                return books.generate('conrefs', 'website', {
+                    testId: 'include-plugins',
+                    prepare: function(bookConref) {
+                        plugin = new Plugin(bookConref, 'blocks');
+                        plugin.load('./blocks', PLUGINS_ROOT);
+
+                        return bookConref.plugins.load(plugin);
+                    }
+                })
+                .then(function(bookConref) {
+                    var readme = fs.readFileSync(
+                        path.join(bookConref.options.output, 'index.html'),
+                        { encoding: 'utf-8' }
+                    );
+
+                    readme.should.be.html({
+                        '.page-inner p#test-plugin-block-shortcuts-1': {
+                            count: 1,
+                            text: 'testtest_block1test',
+                            trim: true
+                        },
+                        '.page-inner p#test-plugin-block-shortcuts-2': {
+                            count: 1,
+                            text: 'testtest_block2test',
+                            trim: true
+                        }
+                    });
+                });
+            });
+        });
+
+
+        it('should correctly extend template blocks with defined end', function() {
+            return testTpl('{% test2 %}hello{% endtest2end %}')
+                .then(function(content) {
+                    content.should.equal('test2hellotest2');
                 });
         });
 
-        it("should correctly extend template blocks with defined end", function() {
+        it('should correctly extend template blocks with sub-blocks', function() {
-            return testTpl("{% test2 %}hello{% endtest2end %}")
+            return testTpl('{% test3join separator=";" %}hello{% also %}world{% endtest3join %}')
                 .then(function(content) {
-                    content.should.equal("test2hellotest2");
+                    content.should.equal('hello;world');
                 });
         });
 
-        it("should correctly extend template blocks with sub-blocks", function() {
+        it('should correctly extend template blocks with different sub-blocks', function() {
-            return testTpl("{% test3join separator=\";\" %}hello{% also %}world{% endtest3join %}")
+            return testTpl('{% test4join separator=";" %}hello{% also %}the{% finally %}world{% endtest4join %}')
                 .then(function(content) {
-                    content.should.equal("hello;world");
+                    content.should.equal('hello;the;world');
                 });
         });
 
-        it("should correctly extend template blocks with different sub-blocks", function() {
+        it('should correctly extend template blocks with arguments (1)', function() {
-            return testTpl("{% test4join separator=\";\" %}hello{% also %}the{% finally %}world{% endtest4join %}")
+            return testTpl('{% test5args "a" %}{% endtest5args %}')
                 .then(function(content) {
-                    content.should.equal("hello;the;world");
+                    content.should.equal('test5atest5');
                 });
         });
 
-        it("should correctly extend template blocks with arguments (1)", function() {
+        it('should correctly extend template blocks with arguments (2)', function() {
-            return testTpl("{% test5args \"a\" %}{% endtest5args %}")
+            return testTpl('{% test5args "a", "b" %}{% endtest5args %}')
                 .then(function(content) {
-                    content.should.equal("test5atest5");
+                    content.should.equal('test5a,btest5');
                 });
         });
 
-        it("should correctly extend template blocks with arguments (2)", function() {
+        it('should correctly extend template blocks with arguments (3)', function() {
-            return testTpl("{% test5args 'a', 'b' %}{% endtest5args %}")
+            return testTpl('{% test5args "a", "b", "c" %}{% endtest5args %}')
                 .then(function(content) {
-                    content.should.equal("test5a,btest5");
+                    content.should.equal('test5a,b,ctest5');
                 });
         });
 
-        it("should correctly extend template blocks with arguments (3)", function() {
+        it('should correctly extend template blocks with args and kwargs', function() {
-            return testTpl("{% test5args 'a', 'b', 'c' %}{% endtest5args %}")
+            return testTpl('{% test5kwargs "a", "b", "c", d="test", e="test2" %}{% endtest5kwargs %}')
                 .then(function(content) {
-                    content.should.equal("test5a,b,ctest5");
+                    content.should.equal('test5a,b,c,d:test,e:test2,__keywords:truetest5');
                 });
         });
 
-        it("should correctly extend template blocks with args and kwargs", function() {
+        it('should correctly extend template blocks with access to context', function() {
-            return testTpl("{% test5kwargs 'a', 'b', 'c', d='test', e='test2' %}{% endtest5kwargs %}")
+            return testTpl('{% set name = "john" %}{% test6context %}{% endtest6context %}', {})
-                .then(function(content) {
+            .then(function(content) {
-                    content.should.equal("test5a,b,c,d:test,e:test2,__keywords:truetest5");
+                content.should.equal('test6johntest6');
-                });
+            });
-        });
-
-        it("should correctly extend template blocks with access to context", function() {
-           return testTpl("{% set name = 'john' %}{% test6context %}{% endtest6context %}", {})
-                .then(function(content) {
-                    content.should.equal("test6johntest6");
-                });
         });
     });
 
-    describe("Blocks without parsing", function() {
+    describe('Blocks without parsing', function() {
         var plugin;
 
         before(function() {
-            plugin = new Plugin(book, "blocks");
+            plugin = new Plugin(book, 'blocks');
-            plugin.load("./blocks", PLUGINS_ROOT);
+            plugin.load('./blocks', PLUGINS_ROOT);
 
             return book.plugins.load(plugin);
         });
@@ -242,21 +308,21 @@ describe("Plugins", function () {
             var filetype = parsers.get(markup);
 
             return book.template.renderString(str, args, options)
-            .then(filetype.page).get("sections").get(0).get("content")
+            .then(filetype.page).get('sections').get(0).get('content')
             .then(book.template.postProcess);
         };
 
-        it("should correctly process unparsable for markdown", function() {
+        it('should correctly process unparsable for markdown', function() {
-            return testTpl(".md", "{% test %}**hello**{% endtest %}")
+            return testTpl('.md', '{% test %}**hello**{% endtest %}')
                 .then(function(content) {
-                    content.should.equal("<p>test**hello**test</p>\n");
+                    content.should.equal('<p>test**hello**test</p>\n');
                 });
         });
 
-        it("should correctly process unparsable for asciidoc", function() {
+        it('should correctly process unparsable for asciidoc', function() {
-            return testTpl(".adoc", "{% test %}**hello**{% endtest %}")
+            return testTpl('.adoc', '{% test %}**hello**{% endtest %}')
                 .then(function(content) {
-                    content.should.equal("<div class=\"paragraph\">\n<p>test**hello**test</p>\n</div>");
+                    content.should.equal('<div class="paragraph">\n<p>test**hello**test</p>\n</div>');
                 });
         });
     });

test/plugins/config/index.js

@@ -0,0 +1 @@
+module.exports = {};

test/plugins/config/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "gitbook-plugin-testconfig",
+    "description": "Test plugin configuration",
+    "main": "index.js",
+    "version": "0.0.1",
+    "engines": {
+        "gitbook": "*"
+    },
+    "gitbook": {
+        "properties": {
+            "hello": {
+                "type": "string",
+                "default": "world"
+            },
+            "testRequired": {
+                "type": "number",
+                "required": true
+            }
+        }
+    }
+}

test/structure.js

@@ -0,0 +1,20 @@
+describe('Structure', function () {
+    var book;
+
+    before(function() {
+        return books.parse('structure')
+            .then(function(_book) {
+                book = _book;
+            });
+    });
+
+
+    it('should prioritize structure defined in book.json', function() {
+        book.readmeFile.should.equal('README.adoc');
+    });
+
+    it('should be case incensitive', function() {
+        book.glossaryFile.should.equal('glossary.md');
+        book.glossary.should.have.lengthOf(1);
+    });
+});

test/website.js

@@ -1,22 +1,26 @@
-describe("Website generator", function () {
+describe('Website generator', function () {
-    describe("Basic Book", function() {
+    describe('Basic Book', function() {
         var book;
 
         before(function() {
-            return books.generate("basic", "website")
+            return books.generate('basic', 'website')
                 .then(function(_book) {
                     book = _book;
                 });
         });
 
-        it("should correctly output an index.html", function() {
+        it('should correctly output an index.html', function() {
-            book.should.have.file("index.html");
+            book.should.have.file('index.html');
         });
 
-        it("should correctly copy assets", function() {
+        it('should correctly copy assets', function() {
-            book.should.have.file("gitbook");
+            book.should.have.file('gitbook');
-            book.should.have.file("gitbook/app.js");
+            book.should.have.file('gitbook/app.js');
-            book.should.have.file("gitbook/style.css");
+            book.should.have.file('gitbook/style.css');
+        });
+
+        it('should not copy ebook assets', function() {
+            book.should.not.have.file('gitbook/ebook.css');
         });
     });
 });

theme/assets/ebook/ebook.css

@@ -0,0 +1 @@
+.section.glossary>h1,.section.toc>h1{text-align:center}.page .section b,.page .section dl dt,.page .section strong,.page .section table th{font-weight:700}.link-inherit,.link-inherit:focus,.link-inherit:hover{color:inherit}.hidden{display:none}.section.toc>ol{margin:0;padding:0}.section.toc li{list-style:none}.section.toc li .inner{display:block;border-bottom:1px dotted #eee;margin-bottom:4px}.section.toc li .inner a,.section.toc li .inner span{padding-right:5px;border-bottom:1px solid #fff;margin-bottom:-1px}.section.toc li .inner .page{float:right;padding-left:5px}.section.toc li ol{margin:0;padding:0 0 0 2em}.dir-rtl .section.toc li .inner .page{float:left}.dir-rtl .section.toc li ol{margin:0;padding:0 2em 0 0}.section.glossary .glossary-entry{margin-bottom:40px}.section.glossary .glossary-entry h2 a,.section.glossary .glossary-entry h2 a:hover{color:inherit;text-decoration:none}.section.glossary .glossary-entry .glossary-index{list-style:none;margin:0;padding:0}.section.glossary .glossary-entry .glossary-index li{display:inline;margin:0 8px;white-space:nowrap}body{font-family:sans-serif;color:#000;text-size-adjust:100%;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}.page .section{display:block;word-wrap:break-word;overflow:hidden;color:#000;line-height:1.6}.page .section *{-moz-box-sizing:border-box;box-sizing:border-box}.page .section>:first-child{margin-top:0!important}.page .section>:last-child{margin-bottom:0!important}.page .section blockquote,.page .section code,.page .section figure,.page .section img,.page .section pre,.page .section table,.page .section tr{page-break-inside:avoid}.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section p{orphans:3;widows:3}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5{page-break-after:avoid}.page .section em{font-style:italic}.page .section blockquote,.page .section dl,.page .section ol,.page .section p,.page .section table,.page .section ul{margin-top:0;margin-bottom:.8em}.page .section a{color:#4183c4;text-decoration:none;background:0 0}.page .section a:active,.page .section a:focus,.page .section a:hover{outline:0;text-decoration:underline}.page .section img{border:0;max-width:100%}.page .section hr{height:4px;padding:0;margin:1.6em 0;overflow:hidden;background-color:#e7e7e7;border:none}.page .section hr:after,.page .section hr:before{display:table;content:" "}.page .section hr:after{clear:both}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section h6{margin-top:1.2em;margin-bottom:.8em;font-weight:700}.page .section h1{font-size:2em}.page .section h2{font-size:1.75em}.page .section h3{font-size:1.5em}.page .section h4{font-size:1.25em}.page .section h5{font-size:1em}.page .section h6{font-size:1em;color:#777}.page .section code,.page .section pre{font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;direction:ltr;border:none}.page .section pre{overflow:auto;word-wrap:normal;margin:0 0 1.2em;padding:.85em 1em;background:#f7f7f7}.page .section pre>code{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;font-size:.85em;white-space:pre;background:0 0}.page .section pre>code:after,.page .section pre>code:before{content:normal}.page .section code{padding:.2em;margin:0;font-size:.85em;background-color:#f7f7f7}.page .section code:after,.page .section code:before{letter-spacing:-.2em;content:"\00a0"}.page .section table{display:table;width:100%;border-collapse:collapse;border-spacing:0;overflow:auto}.page .section table td,.page .section table th{padding:6px 13px;border:1px solid #ddd}.page .section table tr{background-color:#fff;border-top:1px solid #ccc}.page .section table tr:nth-child(2n){background-color:#f8f8f8}.page .section ol,.page .section ul{padding:0 0 0 2em;margin:0 0 .8em}.page .section ol ol,.page .section ol ul,.page .section ul ol,.page .section ul ul{margin-top:0;margin-bottom:0}.page .section ol ol{list-style-type:lower-roman}.page .section blockquote{margin:0 0 .8em;padding:0 15px;color:#858585;border-left:4px solid #e5e5e5}.page .section blockquote:first-child{margin-top:0}.page .section blockquote:last-child{margin-bottom:0}.page .section dl{padding:0}.page .section dl dt{padding:0;margin-top:.8em;font-style:italic}.page .section dl dd{padding:0 .8em;margin-bottom:.8em}.page .section dd{margin-left:0}.page .book-chapter{display:none}

theme/assets/ebook/epub.css

@@ -0,0 +1 @@
+.section.glossary>h1,.section.toc>h1{text-align:center}.page .section b,.page .section dl dt,.page .section strong,.page .section table th{font-weight:700}.link-inherit,.link-inherit:focus,.link-inherit:hover{color:inherit}.hidden{display:none}.section.toc>ol{margin:0;padding:0}.section.toc li{list-style:none}.section.toc li .inner{display:block;border-bottom:1px dotted #eee;margin-bottom:4px}.section.toc li .inner a,.section.toc li .inner span{padding-right:5px;border-bottom:1px solid #fff;margin-bottom:-1px}.section.toc li .inner .page{float:right;padding-left:5px}.section.toc li ol{margin:0;padding:0 0 0 2em}.dir-rtl .section.toc li .inner .page{float:left}.dir-rtl .section.toc li ol{margin:0;padding:0 2em 0 0}.section.glossary .glossary-entry{margin-bottom:40px}.section.glossary .glossary-entry h2 a,.section.glossary .glossary-entry h2 a:hover{color:inherit;text-decoration:none}.section.glossary .glossary-entry .glossary-index{list-style:none;margin:0;padding:0}.section.glossary .glossary-entry .glossary-index li{display:inline;margin:0 8px;white-space:nowrap}body{font-family:serif;color:#000;text-size-adjust:100%;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}.page .section{display:block;word-wrap:break-word;overflow:hidden;color:#000;line-height:1.6}.page .section *{-moz-box-sizing:border-box;box-sizing:border-box}.page .section>:first-child{margin-top:0!important}.page .section>:last-child{margin-bottom:0!important}.page .section blockquote,.page .section code,.page .section figure,.page .section img,.page .section pre,.page .section table,.page .section tr{page-break-inside:avoid}.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section p{orphans:3;widows:3}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5{page-break-after:avoid}.page .section em{font-style:italic}.page .section blockquote,.page .section dl,.page .section ol,.page .section p,.page .section table,.page .section ul{margin-top:0;margin-bottom:.8em}.page .section a{color:#4183c4;text-decoration:none;background:0 0}.page .section a:active,.page .section a:focus,.page .section a:hover{outline:0;text-decoration:underline}.page .section img{border:0;max-width:100%}.page .section hr{height:4px;padding:0;margin:1.6em 0;overflow:hidden;background-color:#e7e7e7;border:none}.page .section hr:after,.page .section hr:before{display:table;content:" "}.page .section hr:after{clear:both}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section h6{margin-top:1.2em;margin-bottom:.8em;font-weight:700}.page .section h1{font-size:2em}.page .section h2{font-size:1.75em}.page .section h3{font-size:1.5em}.page .section h4{font-size:1.25em}.page .section h5{font-size:1em}.page .section h6{font-size:1em;color:#777}.page .section code,.page .section pre{font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;direction:ltr;border:none}.page .section pre{overflow:auto;word-wrap:normal;margin:0 0 1.2em;padding:.85em 1em;background:#f7f7f7}.page .section pre>code{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;font-size:.85em;white-space:pre;background:0 0}.page .section pre>code:after,.page .section pre>code:before{content:normal}.page .section code{padding:.2em;margin:0;font-size:.85em;background-color:#f7f7f7}.page .section code:after,.page .section code:before{letter-spacing:-.2em;content:"\00a0"}.page .section table{display:table;width:100%;border-collapse:collapse;border-spacing:0;overflow:auto}.page .section table td,.page .section table th{padding:6px 13px;border:1px solid #ddd}.page .section table tr{background-color:#fff;border-top:1px solid #ccc}.page .section table tr:nth-child(2n){background-color:#f8f8f8}.page .section ol,.page .section ul{padding:0 0 0 2em;margin:0 0 .8em}.page .section ol ol,.page .section ol ul,.page .section ul ol,.page .section ul ul{margin-top:0;margin-bottom:0}.page .section ol ol{list-style-type:lower-roman}.page .section blockquote{margin:0 0 .8em;padding:0 15px;color:#858585;border-left:4px solid #e5e5e5}.page .section blockquote:first-child{margin-top:0}.page .section blockquote:last-child{margin-bottom:0}.page .section dl{padding:0}.page .section dl dt{padding:0;margin-top:.8em;font-style:italic}.page .section dl dd{padding:0 .8em;margin-bottom:.8em}.page .section dd{margin-left:0}.page .book-chapter{display:none}

theme/assets/ebook/mobi.css

@@ -0,0 +1 @@
+.section.glossary>h1,.section.toc>h1{text-align:center}.page .section b,.page .section dl dt,.page .section strong,.page .section table th{font-weight:700}.link-inherit,.link-inherit:focus,.link-inherit:hover{color:inherit}.hidden{display:none}.section.toc>ol{margin:0;padding:0}.section.toc li{list-style:none}.section.toc li .inner{display:block;border-bottom:1px dotted #eee;margin-bottom:4px}.section.toc li .inner a,.section.toc li .inner span{padding-right:5px;border-bottom:1px solid #fff;margin-bottom:-1px}.section.toc li .inner .page{float:right;padding-left:5px}.section.toc li ol{margin:0;padding:0 0 0 2em}.dir-rtl .section.toc li .inner .page{float:left}.dir-rtl .section.toc li ol{margin:0;padding:0 2em 0 0}.section.glossary .glossary-entry{margin-bottom:40px}.section.glossary .glossary-entry h2 a,.section.glossary .glossary-entry h2 a:hover{color:inherit;text-decoration:none}.section.glossary .glossary-entry .glossary-index{list-style:none;margin:0;padding:0}.section.glossary .glossary-entry .glossary-index li{display:inline;margin:0 8px;white-space:nowrap}body{font-family:serif;color:#000;text-size-adjust:100%;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}.page .section{display:block;word-wrap:break-word;overflow:hidden;color:#000;line-height:1.6}.page .section *{-moz-box-sizing:border-box;box-sizing:border-box}.page .section>:first-child{margin-top:0!important}.page .section>:last-child{margin-bottom:0!important}.page .section blockquote,.page .section code,.page .section figure,.page .section img,.page .section pre,.page .section table,.page .section tr{page-break-inside:avoid}.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section p{orphans:3;widows:3}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5{page-break-after:avoid}.page .section em{font-style:italic}.page .section blockquote,.page .section dl,.page .section ol,.page .section p,.page .section table,.page .section ul{margin-top:0;margin-bottom:.8em}.page .section a{color:#000;text-decoration:none;background:0 0}.page .section a:active,.page .section a:focus,.page .section a:hover{outline:0;text-decoration:underline}.page .section img{border:0;max-width:100%}.page .section hr{height:4px;padding:0;margin:1.6em 0;overflow:hidden;background-color:#e7e7e7;border:none}.page .section hr:after,.page .section hr:before{display:table;content:" "}.page .section hr:after{clear:both}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section h6{margin-top:1.2em;margin-bottom:.8em;font-weight:700}.page .section h1{font-size:2em}.page .section h2{font-size:1.75em}.page .section h3{font-size:1.5em}.page .section h4{font-size:1.25em}.page .section h5{font-size:1em}.page .section h6{font-size:1em;color:#777}.page .section code,.page .section pre{font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;direction:ltr;border:none}.page .section pre{overflow:auto;word-wrap:normal;margin:0 0 1.2em;padding:.85em 1em;background:#f7f7f7}.page .section pre>code{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;font-size:.85em;white-space:pre;background:0 0}.page .section pre>code:after,.page .section pre>code:before{content:normal}.page .section code{padding:.2em;margin:0;font-size:.85em;background-color:#f7f7f7}.page .section code:after,.page .section code:before{letter-spacing:-.2em;content:"\00a0"}.page .section table{display:table;width:100%;border-collapse:collapse;border-spacing:0;overflow:auto}.page .book-chapter,.page-toc li .inner span.page{display:none}.page .section table td,.page .section table th{padding:6px 13px;border:1px solid #ddd}.page .section table tr{background-color:#fff;border-top:1px solid #ccc}.page .section table tr:nth-child(2n){background-color:#f8f8f8}.page .section ol,.page .section ul{padding:0 0 0 2em;margin:0 0 .8em}.page .section ol ol,.page .section ol ul,.page .section ul ol,.page .section ul ul{margin-top:0;margin-bottom:0}.page .section ol ol{list-style-type:lower-roman}.page .section blockquote{margin:0 0 .8em;padding:0 15px;color:#858585;border-left:4px solid #e5e5e5}.page .section blockquote:first-child{margin-top:0}.page .section blockquote:last-child{margin-bottom:0}.page .section dl{padding:0}.page .section dl dt{padding:0;margin-top:.8em;font-style:italic}.page .section dl dd{padding:0 .8em;margin-bottom:.8em}.page .section dd{margin-left:0}a{color:#000;text-decoration:underline!important}.page-toc li{list-style-type:lower-alpha}.page-toc li .inner{border:none}

theme/assets/ebook/pdf.css

@@ -0,0 +1 @@
+.section.glossary>h1,.section.toc>h1{text-align:center}.page .section b,.page .section dl dt,.page .section strong,.page .section table th{font-weight:700}.link-inherit,.link-inherit:focus,.link-inherit:hover{color:inherit}.hidden{display:none}.section.toc>ol{margin:0;padding:0}.section.toc li{list-style:none}.section.toc li .inner{display:block;border-bottom:1px dotted #eee;margin-bottom:4px}.section.toc li .inner a,.section.toc li .inner span{padding-right:5px;border-bottom:1px solid #fff;margin-bottom:-1px}.section.toc li .inner .page{float:right;padding-left:5px}.section.toc li ol{margin:0;padding:0 0 0 2em}.dir-rtl .section.toc li .inner .page{float:left}.dir-rtl .section.toc li ol{margin:0;padding:0 2em 0 0}.section.glossary .glossary-entry{margin-bottom:40px}.section.glossary .glossary-entry h2 a,.section.glossary .glossary-entry h2 a:hover{color:inherit;text-decoration:none}.section.glossary .glossary-entry .glossary-index{list-style:none;margin:0;padding:0}.section.glossary .glossary-entry .glossary-index li{display:inline;margin:0 8px;white-space:nowrap}body{font-family:sans-serif;color:#000;text-size-adjust:100%;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}.page .section{display:block;word-wrap:break-word;overflow:hidden;color:#000;line-height:1.6}.page .section *{-moz-box-sizing:border-box;box-sizing:border-box}.page .section>:first-child{margin-top:0!important}.page .section>:last-child{margin-bottom:0!important}.page .section blockquote,.page .section code,.page .section figure,.page .section img,.page .section pre,.page .section table,.page .section tr{page-break-inside:avoid}.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section p{orphans:3;widows:3}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5{page-break-after:avoid}.page .section em{font-style:italic}.page .section blockquote,.page .section dl,.page .section ol,.page .section p,.page .section table,.page .section ul{margin-top:0;margin-bottom:.8em}.page .section a{color:#4183c4;text-decoration:none;background:0 0}.page .section a:active,.page .section a:focus,.page .section a:hover{outline:0;text-decoration:underline}.page .section img{border:0;max-width:100%}.page .section hr{height:4px;padding:0;margin:1.6em 0;overflow:hidden;background-color:#e7e7e7;border:none}.page .section hr:after,.page .section hr:before{display:table;content:" "}.page .section hr:after{clear:both}.page .section h1,.page .section h2,.page .section h3,.page .section h4,.page .section h5,.page .section h6{margin-top:1.2em;margin-bottom:.8em;font-weight:700}.page .section h1{font-size:2em}.page .section h2{font-size:1.75em}.page .section h3{font-size:1.5em}.page .section h4{font-size:1.25em}.page .section h5{font-size:1em}.page .section h6{font-size:1em;color:#777}.page .section code,.page .section pre{font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;direction:ltr;border:none}.page .section pre{overflow:auto;word-wrap:normal;margin:0 0 1.2em;padding:.85em 1em;background:#f7f7f7}.page .section pre>code{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;font-size:.85em;white-space:pre;background:0 0}.page .section pre>code:after,.page .section pre>code:before{content:normal}.page .section code{padding:.2em;margin:0;font-size:.85em;background-color:#f7f7f7}.page .section code:after,.page .section code:before{letter-spacing:-.2em;content:"\00a0"}.page .section table{display:table;width:100%;border-collapse:collapse;border-spacing:0;overflow:auto}.page .section table td,.page .section table th{padding:6px 13px;border:1px solid #ddd}.page .section table tr{background-color:#fff;border-top:1px solid #ccc}.page .section table tr:nth-child(2n){background-color:#f8f8f8}.page .section ol,.page .section ul{padding:0 0 0 2em;margin:0 0 .8em}.page .section ol ol,.page .section ol ul,.page .section ul ol,.page .section ul ul{margin-top:0;margin-bottom:0}.page .section ol ol{list-style-type:lower-roman}.page .section blockquote{margin:0 0 .8em;padding:0 15px;color:#858585;border-left:4px solid #e5e5e5}.page .section blockquote:first-child{margin-top:0}.page .section blockquote:last-child{margin-bottom:0}.page .section dl{padding:0}.page .section dl dt{padding:0;margin-top:.8em;font-style:italic}.pdf-footer,.pdf-header{margin-top:20px;color:#aaa}.page .section dl dd{padding:0 .8em;margin-bottom:.8em}.page .section dd{margin-left:0}.page .book-chapter{display:none}.pdf-footer{padding-top:10px;border-top:1px solid #eee}.pdf-footer .footer-pages-count{float:right}.pdf-header{padding-bottom:10px;border-bottom:1px solid #eee}

theme/assets/print.css

@@ -1 +0,0 @@
-.link-inherit{color:inherit}.link-inherit:hover,.link-inherit:focus{color:inherit}.hidden{display:none}.page.page-toc .glossary{margin-bottom:40px}.page.page-toc .glossary h2 a,.page.page-toc .glossary h2 a:hover{color:inherit;text-decoration:none}.page.page-toc .glossary .glossary-index{list-style:none;margin:0;padding:0}.page.page-toc .glossary .glossary-index li{display:inline;margin:0 8px;white-space:nowrap}.page .book-chapter{display:none}body .page{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;line-height:1.4;color:#000;overflow:hidden;line-height:1.6;word-wrap:break-word;display:block}body .page>*:first-child{margin-top:0!important}body .page>*:last-child{margin-bottom:0!important}body .page a{background:transparent}body .page a:active,body .page a:hover{outline:0}body .page strong{font-weight:bold}body .page h1{font-size:2em;margin:.67em 0}body .page img{border:0}body .page hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}body .page pre{overflow:auto}body .page code,body .page pre{font-family:monospace,monospace;font-size:1em;direction:ltr}body .page table{border-collapse:collapse;border-spacing:0}body .page td,body .page th{padding:0}body .page *{-moz-box-sizing:border-box;box-sizing:border-box}body .page a{color:#4183c4;text-decoration:none}body .page a:hover,body .page a:focus,body .page a:active{text-decoration:underline}body .page hr{height:0;margin:15px 0;overflow:hidden;background:transparent;border:0;border-bottom:1px solid #ddd}body .page hr:before,body .page hr:after{display:table;content:" "}body .page hr:after{clear:both}body .page h1,body .page h2,body .page h3,body .page h4,body .page h5,body .page h6{margin-top:15px;margin-bottom:15px;line-height:1.1}body .page h1{font-size:30px}body .page h2{font-size:21px}body .page h3{font-size:16px}body .page h4{font-size:14px}body .page h5{font-size:12px}body .page h6{font-size:11px}body .page blockquote{margin:0}body .page ul,body .page ol{padding:0;margin-top:0;margin-bottom:0}body .page ol ol{list-style-type:lower-roman}body .page dd{margin-left:0}body .page code,body .page pre{font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;font-size:12px}body .page pre{margin-top:0;margin-bottom:0}body .page .markdown-body>*:first-child{margin-top:0!important}body .page .markdown-body>*:last-child{margin-bottom:0!important}body .page .anchor{position:absolute;top:0;bottom:0;left:0;display:block;padding-right:6px;padding-left:30px;margin-left:-30px}body .page .anchor:focus{outline:0}body .page h1,body .page h2,body .page h3,body .page h4,body .page h5,body .page h6{position:relative;margin-top:1em;margin-bottom:16px;font-weight:bold;line-height:1.4}body .page h1{padding-bottom:.3em;font-size:2.25em;line-height:1.2;border-bottom:1px solid #eee}body .page h2{padding-bottom:.3em;font-size:1.75em;line-height:1.225;border-bottom:1px solid #eee}body .page h3{font-size:1.5em;line-height:1.43}body .page h4{font-size:1.25em}body .page h5{font-size:1em}body .page h6{font-size:1em;color:#777}body .page p,body .page blockquote,body .page ul,body .page ol,body .page dl,body .page table,body .page pre{margin-top:0;margin-bottom:16px}body .page hr{height:4px;padding:0;margin:16px 0;background-color:#e7e7e7;border:0 none}body .page ul,body .page ol{padding-left:2em}body .page ol ol,body .page ol ul,body .page ul ul{margin-top:0;margin-bottom:0}body .page dl{padding:0}body .page dl dt{padding:0;margin-top:16px;font-size:1em;font-style:italic;font-weight:bold}body .page dl dd{padding:0 16px;margin-bottom:16px}body .page blockquote{padding:0 15px;color:#777;border-left:4px solid #ddd}body .page blockquote>:first-child{margin-top:0}body .page blockquote>:last-child{margin-bottom:0}body .page table{display:block;width:100%;overflow:auto}body .page table th{font-weight:bold}body .page table th,body .page table td{padding:6px 13px;border:1px solid #ddd}body .page table tr{background-color:#fff;border-top:1px solid #ccc}body .page table tr:nth-child(2n){background-color:#f8f8f8}body .page img{max-width:100%;-moz-box-sizing:border-box;box-sizing:border-box;page-break-inside:avoid}body .page code{padding:0;padding-top:.2em;padding-bottom:.2em;margin:0;font-size:85%;background-color:#f7f7f7;border-radius:3px}body .page code:before,body .page code:after{letter-spacing:-0.2em;content:"\00a0"}body .page pre>code{padding:0;margin:0;font-size:100%;white-space:pre;background:transparent;border:0}body .page .highlight pre,body .page pre{padding:16px;overflow:auto;font-size:85%;line-height:1.45;background-color:#f7f7f7;border:0;border-radius:3px}body .page pre{word-wrap:normal}body .page pre code{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;word-wrap:normal;background-color:transparent;border:0}body .page pre code:before,body .page pre code:after{content:normal}body .page .highlight{background:#fff}

theme/i18n/cs.json

@@ -0,0 +1,20 @@
+{
+    "LANGS_CHOOSE": "Zvolte jazyk",
+    "GLOSSARY": "Slovníček",
+    "GLOSSARY_INDEX": "Rejstřík",
+    "GLOSSARY_OPEN": "Slovníček",
+    "GITBOOK_LINK": "Publikováno pomocí GitBook",
+    "SUMMARY": "Obsah",
+    "SUMMARY_INTRODUCTION": "Úvod",
+    "SUMMARY_TOGGLE": "Obsah",
+    "SEARCH_TOGGLE": "Hledání",
+    "SEARCH_PLACEHOLDER": "Vyhledat",
+    "FONTSETTINGS_TOGGLE": "Nastavení písma",
+    "SHARE_TOGGLE": "Sdílet",
+    "SHARE_ON": "Sdílet na {{platform}}",
+    "FONTSETTINGS_WHITE": "Bílá",
+    "FONTSETTINGS_SEPIA": "Sépie",
+    "FONTSETTINGS_NIGHT": "Noc",
+    "FONTSETTINGS_SANS": "Bezpatkové",
+    "FONTSETTINGS_SERIF": "Patkové"
+}

theme/i18n/sv.json

@@ -0,0 +1,20 @@
+{
+    "LANGS_CHOOSE": "Välj språk",
+    "GLOSSARY": "Gloslista",
+    "GLOSSARY_INDEX": "Index",
+    "GLOSSARY_OPEN": "Gloslista",
+    "GITBOOK_LINK": "Publicera med GitBook",
+    "SUMMARY": "Innehållsförteckning",
+    "SUMMARY_INTRODUCTION": "Inledning",
+    "SUMMARY_TOGGLE": "Innehållsförteckning",
+    "SEARCH_TOGGLE": "Sök",
+    "SEARCH_PLACEHOLDER": "Skriv sökord",
+    "FONTSETTINGS_TOGGLE": "Textinställningar",
+    "SHARE_TOGGLE": "Dela",
+    "SHARE_ON": "Dela på {{platform}}",
+    "FONTSETTINGS_WHITE": "Ljus",
+    "FONTSETTINGS_SEPIA": "Sepia",
+    "FONTSETTINGS_NIGHT": "Mörk",
+    "FONTSETTINGS_SANS": "Sans",
+    "FONTSETTINGS_SERIF": "Serif"
+}

theme/i18n/uk.json

@@ -0,0 +1,20 @@
+{
+    "LANGS_CHOOSE": "Виберіть мову",
+    "GLOSSARY": "Глосарій",
+    "GLOSSARY_INDEX": "Глосарій",
+    "GLOSSARY_OPEN": "Глосарій",
+    "GITBOOK_LINK": "Опубліковано за допомогою GitBook",
+    "SUMMARY": "Зміст",
+    "SUMMARY_INTRODUCTION": "Вступ",
+    "SUMMARY_TOGGLE": "Зміст",
+    "SEARCH_TOGGLE": "Пошук",
+    "SEARCH_PLACEHOLDER": "Введіть для пошуку",
+    "FONTSETTINGS_TOGGLE": "Шрифт",
+    "SHARE_TOGGLE": "Поділиться",
+    "SHARE_ON": "Поділитися в {{platform}}",
+    "FONTSETTINGS_WHITE": "Світлий",
+    "FONTSETTINGS_SEPIA": "Сепія",
+    "FONTSETTINGS_NIGHT": "Темний",
+    "FONTSETTINGS_SANS": "Sans",
+    "FONTSETTINGS_SERIF": "Serif"
+}

theme/javascript/core/events.js

@@ -1,7 +0,0 @@
-define([
-    "jQuery"
-], function($) {
-   var events = $({});
-
-    return events;
-});

theme/javascript/core/font-settings.js

@@ -1,103 +0,0 @@
-define([
-    "jQuery",
-    "utils/storage"
-], function($, storage) {
-    var fontState;
-
-    var THEMES = {
-        "white": 0,
-        "sepia": 1,
-        "night": 2
-    };
-
-    var FAMILY = {
-        "serif": 0,
-        "sans": 1
-    };
-
-    var enlargeFontSize = function(e){
-        if (fontState.size < 4){
-            fontState.size++;
-            fontState.save();
-        }
-    };
-
-    var reduceFontSize = function(e){
-        if (fontState.size > 0){
-            fontState.size--;
-            fontState.save();
-        }
-    };
-
-    var changeFontFamily = function(){
-        var index = $(this).data("font");
-
-        fontState.family = index;
-        fontState.save();
-    };
-
-    var changeColorTheme = function(){
-        var $book = $(".book");
-        var index = $(this).data("theme");
-
-        if (fontState.theme !== 0)
-            $book.removeClass("color-theme-"+fontState.theme);
-
-        fontState.theme = index;
-        if (fontState.theme !== 0)
-            $book.addClass("color-theme-"+fontState.theme);
-
-        fontState.save();
-    };
-
-    var update = function() {
-        var $book = $(".book");
-
-        $(".font-settings .font-family-list li").removeClass("active");
-        $(".font-settings .font-family-list li:nth-child("+(fontState.family+1)+")").addClass("active");
-
-        $book[0].className = $book[0].className.replace(/\bfont-\S+/g, '');
-        $book.addClass("font-size-"+fontState.size);
-        $book.addClass("font-family-"+fontState.family);
-
-        if(fontState.theme !== 0) {
-            $book[0].className = $book[0].className.replace(/\bcolor-theme-\S+/g, '');
-            $book.addClass("color-theme-"+fontState.theme);
-        }
-    };
-
-    var init = function(config) {
-        var $toggle, $bookBody, $dropdown, $book;
-
-        //Find DOM elements.
-        $book = $(".book");
-        $toggle = $(".book-header .toggle-font-settings");
-        $dropdown = $("#font-settings-wrapper .dropdown-menu");
-        $bookBody = $(".book-body");
-
-        // Instantiate font state object
-        fontState = storage.get("fontState", {
-            size: config.size || 2,
-            family: FAMILY[config.family || "sans"],
-            theme: THEMES[config.theme || "white"]
-        });
-        fontState.save = function(){
-            storage.set("fontState",fontState);
-            update();
-        };
-
-        update();
-
-        //Add event listeners
-        $(document).on('click', "#enlarge-font-size", enlargeFontSize);
-        $(document).on('click', "#reduce-font-size", reduceFontSize);
-
-        $(document).on('click', "#font-settings-wrapper .font-family-list .button", changeFontFamily);
-        $(document).on('click', "#font-settings-wrapper .color-theme-list .button", changeColorTheme);
-    };
-
-    return {
-        init: init,
-        update: update
-    }
-});

theme/javascript/core/keyboard.js

@@ -1,38 +0,0 @@
-define([
-    "jQuery",
-    "Mousetrap",
-    "core/navigation",
-    "core/sidebar",
-    "core/search"
-], function($, Mousetrap, navigation, sidebar, search){
-    // Bind keyboard shortcuts
-    var init = function() {
-        // Next
-        Mousetrap.bind(['right'], function(e) {
-            navigation.goNext();
-            return false;
-        });
-
-        // Prev
-        Mousetrap.bind(['left'], function(e) {
-            navigation.goPrev();
-            return false;
-        });
-
-        // Toggle Summary
-        Mousetrap.bind(['s'], function(e) {
-            sidebar.toggle();
-            return false;
-        });
-
-        // Toggle Search
-        Mousetrap.bind(['f'], function(e) {
-            search.toggle();
-            return false;
-        });
-    };
-
-    return {
-        init: init
-    };
-});

theme/javascript/core/loading.js

@@ -1,16 +0,0 @@
-define([
-    "jQuery"
-], function($) {
-    var showLoading = function(p) {
-        $(".book").addClass("is-loading");
-        p.always(function() {
-            $(".book").removeClass("is-loading");
-        });
-
-        return p;
-    };
-
-    return {
-        show: showLoading
-    };
-});

theme/javascript/core/navigation.js

@@ -1,174 +0,0 @@
-define([
-    "jQuery",
-    "utils/url",
-    "core/events",
-    "core/state",
-    "core/progress",
-    "core/loading",
-    "core/search"
-], function($, URL, events, state, progress, loading, search) {
-    var prev, next;
-
-    var usePushState = (typeof history.pushState !== "undefined");
-
-    var handleNavigation = function(relativeUrl, push) {
-        var url = URL.join(window.location.pathname, relativeUrl);
-        console.log("navigate to ", url, "baseurl="+relativeUrl, "current="+window.location.pathname);
-
-        if (!usePushState) {
-            // Refresh the page to the new URL if pushState not supported
-            location.href = relativeUrl;
-            return
-        }
-
-        return loading.show($.get(url)
-        .done(function (html) {
-            // Push url to history
-            if (push) history.pushState({ path: url }, null, url);
-
-            // Replace html content
-            html = html.replace( /<(\/?)(html|head|body)([^>]*)>/ig, function(a,b,c,d){
-                return '<' + b + 'div' + ( b ? '' : ' data-element="' + c + '"' ) + d + '>';
-            });
-
-            var $page = $(html);
-            var $pageHead = $page.find("[data-element=head]");
-            var $pageBody = $page.find('.book');
-
-            ////
-            // Merge heads
-            // !! Warning !!: we only update necessary portions to avoid strange behavior (page flickering etc ...)
-            ////
-
-            // Update title
-            document.title = $pageHead.find("title").text();
-
-            // Reference to $("head");
-            var $head = $("head");
-
-            // Update next & prev <link> tags
-            // Remove old
-            $head.find("link[rel=prev]").remove();
-            $head.find("link[rel=next]").remove();
-
-            // Add new next * prev <link> tags
-            $head.append($pageHead.find("link[rel=prev]"));
-            $head.append($pageHead.find("link[rel=next]"));
-
-            // Merge body
-            var bodyClass = $(".book").attr("class");
-            var scrollPosition = $('.book-summary .summary').scrollTop();
-            $pageBody.toggleClass("with-summary", $(".book").hasClass("with-summary"))
-
-            $(".book").replaceWith($pageBody);
-            $(".book").attr("class", bodyClass);
-            $('.book-summary .summary').scrollTop(scrollPosition);
-
-            // Update state
-            state.update($("html"));
-            // recover search keyword
-            search.recover();
-            preparePage();
-        })
-        .fail(function (e) {
-            location.href = relativeUrl;
-        }));
-    };
-
-    var updateNavigationPosition = function() {
-        var bodyInnerWidth, pageWrapperWidth;
-
-        bodyInnerWidth = parseInt($('.body-inner').css('width'), 10);
-        pageWrapperWidth = parseInt($('.page-wrapper').css('width'), 10);
-        $('.navigation-next').css('margin-right', (bodyInnerWidth - pageWrapperWidth) + 'px');
-    };
-
-    var preparePage = function() {
-        var $bookBody = $(".book-body");
-        var $bookInner = $bookBody.find(".body-inner");
-        var $pageWrapper = $bookInner.find(".page-wrapper");
-
-        // Show progress
-        progress.show();
-
-        // Update navigation position
-        updateNavigationPosition();
-
-        // Focus on content
-        $pageWrapper.focus();
-
-        // Reset scroll
-        $bookInner.scrollTop(0);
-        $bookBody.scrollTop(0);
-
-        // Notify
-        events.trigger("page.change");
-    };
-
-    var isLeftClickEvent = function (e) {
-        return e.button === 0;
-    };
-
-    var isModifiedEvent = function (e) {
-        return !!(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey);
-    };
-
-    var handlePagination = function (e) {
-        if (isModifiedEvent(e) || !isLeftClickEvent(e)) {
-          return;
-        }
-
-        e.stopPropagation();
-        e.preventDefault();
-
-        var url = $(this).attr('href');
-        if (url) handleNavigation(url, true);
-    };
-
-    var goNext = function() {
-        var url = $(".navigation-next").attr("href");
-        if (url) handleNavigation(url, true);
-    };
-
-    var goPrev = function() {
-        var url = $(".navigation-prev").attr("href");
-        if (url) handleNavigation(url, true);
-    };
-
-
-
-    var init = function() {
-        // Prevent cache so that using the back button works
-        // See: http://stackoverflow.com/a/15805399/983070
-        $.ajaxSetup({
-            cache: false
-        });
-
-        // Recreate first page when the page loads.
-        history.replaceState({ path: window.location.href }, '');
-
-        // Back Button Hijacking :(
-        window.onpopstate = function (event) {
-            if (event.state === null) {
-                return;
-            }
-            return handleNavigation(event.state.path, false);
-        };
-
-        $(document).on('click', ".navigation-prev", handlePagination);
-        $(document).on('click', ".navigation-next", handlePagination);
-        $(document).on('click', ".summary [data-path] a", handlePagination);
-
-        $(window).resize(updateNavigationPosition);
-
-        // Prepare current page
-        preparePage();
-    };
-
-    return {
-        init: init,
-        goNext: goNext,
-        goPrev: goPrev
-    };
-});
-

theme/javascript/core/progress.js

@@ -1,73 +0,0 @@
-define([
-    "lodash",
-    "jQuery",
-    "utils/storage",
-    "core/state"
-], function(_, $, storage, state) {
-    // Get current level
-    var getCurrentLevel = function() {
-        return state.level;
-    };
-
-    // Return all levels
-    var getLevels = function () {
-        var levels = $(".book-summary li[data-level]");
-
-        return _.map(levels, function(level) {
-            return $(level).data("level").toString();
-        });
-    };
-
-    // Return a map chapter -> number (timestamp)
-    var getProgress = function () {
-        // Current level
-        var progress = storage.get("progress", {});
-
-        // Levels
-        var levels = getLevels();
-
-        _.each(levels, function(level) {
-            progress[level] = progress[level] || 0;
-        });
-
-        return progress;
-    };
-
-    // Change value of progress for a level
-    var markProgress = function (level, state) {
-        var progress = getProgress();
-
-        if (state == null) {
-            state = true;
-        }
-
-        progress[level] = state
-            ? Date.now()
-            : 0;
-
-        storage.set("progress", progress);
-    };
-
-    // Show progress
-    var showProgress = function () {
-        var progress = getProgress();
-        var $summary = $(".book-summary");
-
-        _.each(progress, function (value, level) {
-            $summary.find("li[data-level='"+level+"']").toggleClass("done", value > 0);
-        });
-
-        // Mark current progress if we have not already
-        if (!progress[getCurrentLevel()]) {
-            markProgress(getCurrentLevel(), true);
-        }
-    };
-
-    return {
-        'current': getCurrentLevel,
-        'levels': getLevels,
-        'get': getProgress,
-        'mark': markProgress,
-        'show': showProgress
-    };
-});

theme/javascript/core/search.js

@@ -1,114 +0,0 @@
-define([
-    "jQuery",
-    "lodash",
-    "lunr",
-    "utils/storage",
-    "core/state",
-    "core/sidebar"
-], function($, _, lunr, storage, state, sidebar) {
-    var index = null;
-
-    // Use a specific idnex
-    var useIndex = function(data) {
-        index = lunr.Index.load(data);
-    };
-
-    // Load complete index
-    var loadIndex = function() {
-        $.getJSON(state.basePath+"/search_index.json")
-        .then(useIndex);
-    };
-
-    // Search for a term
-    var search = function(q) {
-        if (!index) return;
-        var results = _.chain(index.search(q))
-        .map(function(result) {
-            var parts = result.ref.split("#")
-            return {
-                path: parts[0],
-                hash: parts[1]
-            }
-        })
-        .value();
-
-        return results;
-    };
-
-    // Toggle search bar
-    var toggleSearch = function(_state) {
-        if (state != null && isSearchOpen() == _state) return;
-
-        var $searchInput = $(".book-search input");
-        state.$book.toggleClass("with-search", _state);
-
-        // If search bar is open: focus input
-        if (isSearchOpen()) {
-            sidebar.toggle(true);
-            $searchInput.focus();
-        } else {
-            $searchInput.blur();
-            $searchInput.val("");
-            sidebar.filter(null);
-        }
-    };
-
-    // Return true if search bar is open
-    var isSearchOpen = function() {
-        return state.$book.hasClass("with-search");
-    };
-
-
-    var init = function() {
-        loadIndex();
-
-        // Toggle search
-        $(document).on("click", ".book-header .toggle-search", function(e) {
-            e.preventDefault();
-            toggleSearch();
-        });
-
-
-        // Type in search bar
-        $(document).on("keyup", ".book-search input", function(e) {
-            var key = (e.keyCode ? e.keyCode : e.which);
-            var q = $(this).val();
-
-            if (key == 27) {
-                e.preventDefault();
-                toggleSearch(false);
-                return;
-            }
-            if (q.length == 0) {
-                sidebar.filter(null);
-                storage.remove("keyword");
-            } else {
-                var results = search(q);
-                sidebar.filter(
-                    _.pluck(results, "path")
-                );
-                storage.set("keyword", q);
-            }
-        })
-
-    };
-
-    // filter sidebar menu with current search keyword
-    var recoverSearch = function() {
-        var keyword = storage.get("keyword", "");
-        if(keyword.length > 0) {
-            if(!isSearchOpen()){
-                toggleSearch();
-            }
-            sidebar.filter(_.pluck(search(keyword), "path"));
-        }
-        $(".book-search input").val(keyword);
-    };
-
-    return {
-        init: init,
-        search: search,
-        toggle: toggleSearch,
-        recover:recoverSearch
-    };
-});

theme/javascript/core/sidebar.js

@@ -1,56 +0,0 @@
-define([
-    "jQuery",
-    "lodash",
-    "utils/storage",
-    "utils/platform",
-    "core/state"
-], function($, _, storage, platform, state) {
-    // Toggle sidebar with or withour animation
-    var toggleSidebar = function(_state, animation) {
-        if (state != null && isOpen() == _state) return;
-        if (animation == null) animation = true;
-
-        state.$book.toggleClass("without-animation", !animation);
-        state.$book.toggleClass("with-summary", _state);
-
-        storage.set("sidebar", isOpen());
-    };
-
-    // Return true if sidebar is open
-    var isOpen = function() {
-        return state.$book.hasClass("with-summary");
-    };
-
-    // Prepare sidebar: state and toggle button
-    var init = function() {
-        // Toggle summary
-        $(document).on("click", ".book-header .toggle-summary", function(e) {
-            e.preventDefault();
-            toggleSidebar();
-        });
-
-        // Init last state if not mobile
-        if (!platform.isMobile) {
-            toggleSidebar(storage.get("sidebar", true), false);
-        }
-    };
-
-    // Filter summary with a list of path
-    var filterSummary = function(paths) {
-        var $summary = $(".book-summary");
-
-        $summary.find("li").each(function() {
-            var path = $(this).data("path");
-            var st = paths == null || _.contains(paths, path);
-
-            $(this).toggle(st);
-            if (st) $(this).parents("li").show();
-        });
-    };
-
-    return {
-        init: init,
-        toggle: toggleSidebar,
-        filter: filterSummary
-    }
-});

theme/javascript/core/state.js

@@ -1,18 +0,0 @@
-define([
-    "jQuery"
-], function() {
-    var state = {};
-
-    state.update = function(dom) {
-        var $book = $(dom.find(".book"));
-
-        state.$book = $book;
-        state.level = $book.data("level");
-        state.basePath = $book.data("basepath");
-        state.revision = $book.data("revision");
-    };
-
-    state.update($);
-
-    return state;
-});

theme/javascript/dropdown.js

@@ -0,0 +1,25 @@
+var $ = require('jquery');
+
+function toggleDropdown(e) {
+    var $dropdown = $(e.currentTarget).parent().find('.dropdown-menu');
+
+    $dropdown.toggleClass('open');
+    e.stopPropagation();
+    e.preventDefault();
+}
+
+function closeDropdown(e) {
+    $('.dropdown-menu').removeClass('open');
+}
+
+// Bind all dropdown
+function init() {
+    $(document).on('click', '.toggle-dropdown', toggleDropdown);
+    $(document).on('click', '.dropdown-menu', function(e){ e.stopPropagation(); });
+    $(document).on('click', closeDropdown);
+}
+
+module.exports = {
+    init: init
+};
+

theme/javascript/events.js

@@ -0,0 +1,4 @@
+var $ = require('jquery');
+
+module.exports = $({});
+

theme/javascript/gitbook.js

@@ -1,49 +0,0 @@
-define([
-    "jQuery",
-    "utils/storage",
-    "utils/sharing",
-    "utils/dropdown",
-
-    "core/events",
-    "core/font-settings",
-    "core/state",
-    "core/keyboard",
-    "core/navigation",
-    "core/progress",
-    "core/sidebar",
-    "core/search"
-], function($, storage, sharing, dropdown, events, fontSettings, state, keyboard, navigation, progress, sidebar, search){
-    var start = function(config) {
-        var $book;
-        $book = state.$book;
-
-        // Init sidebar
-        sidebar.init();
-
-        // Load search
-        search.init();
-
-        // Init keyboard
-        keyboard.init();
-
-        // Bind sharing button
-        sharing.init();
-
-        // Bind dropdown
-        dropdown.init();
-
-        // Init navigation
-        navigation.init();
-
-        //Init font settings
-        fontSettings.init(config.fontSettings || {});
-
-        events.trigger("start", config);
-    }
-
-    return {
-        start: start,
-        events: events,
-        state: state
-    };
-});

theme/javascript/index.js

@@ -0,0 +1,84 @@
+var $ = require('jquery');
+var _ = require('lodash');
+
+var storage = require('./storage');
+var dropdown = require('./dropdown');
+var events = require('./events');
+var state = require('./state');
+var keyboard = require('./keyboard');
+var navigation = require('./navigation');
+var sidebar = require('./sidebar');
+var toolbar = require('./toolbar');
+
+
+function start(config) {
+    // Init sidebar
+    sidebar.init();
+
+    // Init keyboard
+    keyboard.init();
+
+    // Bind dropdown
+    dropdown.init();
+
+    // Init navigation
+    navigation.init();
+
+
+    // Add action to toggle sidebar
+    toolbar.createButton({
+        index: 0,
+        icon: 'fa fa-align-justify',
+        onClick: function(e) {
+            e.preventDefault();
+            sidebar.toggle();
+        }
+    });
+
+    events.trigger('start', config);
+    navigation.notify();
+}
+
+// Export APIs for plugins
+var gitbook = {
+    start: start,
+    events: events,
+    state: state,
+
+    // UI sections
+    toolbar: toolbar,
+    sidebar: sidebar,
+
+    // Read/Write the localstorage
+    storage: storage,
+
+    // Create keyboard shortcuts
+    keyboard: keyboard
+};
+
+
+// Modules mapping for plugins
+var MODULES = {
+    'gitbook': gitbook,
+    'jquery': $,
+    'lodash': _
+};
+
+window.gitbook = gitbook;
+window.$ = $;
+window.jQuery = $;
+window.require = function(mods, fn) {
+    mods = _.map(mods, function(mod) {
+        mod = mod.toLowerCase();
+        if (!MODULES[mod]) {
+            throw new Error('GitBook module '+mod+' doesn\'t exist');
+        }
+
+        return MODULES[mod];
+    });
+
+    fn.apply(null, mods);
+};
+
+module.exports = {};
+

theme/javascript/keyboard.js

@@ -0,0 +1,36 @@
+var Mousetrap = require('mousetrap');
+
+var navigation = require('./navigation');
+var sidebar = require('./sidebar');
+
+// Bind a keyboard shortcuts
+function bindShortcut(keys, fn) {
+    Mousetrap.bind(keys, function(e) {
+        fn();
+        return false;
+    });
+}
+
+
+// Bind keyboard shortcuts
+function init() {
+    // Next
+    bindShortcut(['right'], function(e) {
+        navigation.goNext();
+    });
+
+    // Prev
+    bindShortcut(['left'], function(e) {
+        navigation.goPrev();
+    });
+
+    // Toggle Summary
+    bindShortcut(['s'], function(e) {
+        sidebar.toggle();
+    });
+}
+
+module.exports = {
+    init: init,
+    bind: bindShortcut
+};

theme/javascript/loading.js

@@ -0,0 +1,14 @@
+var state = require('./state');
+
+function showLoading(p) {
+    state.$book.addClass('is-loading');
+    p.always(function() {
+        state.$book.removeClass('is-loading');
+    });
+
+    return p;
+}
+
+module.exports = {
+    show: showLoading
+};

theme/javascript/navigation.js

@@ -0,0 +1,165 @@
+var $ = require('jquery');
+var url = require('url');
+
+var events = require('./events');
+var state = require('./state');
+var loading = require('./loading');
+
+
+var usePushState = (typeof history.pushState !== 'undefined');
+
+function handleNavigation(relativeUrl, push) {
+    var uri = url.resolve(window.location.pathname, relativeUrl);
+
+    if (!usePushState) {
+        // Refresh the page to the new URL if pushState not supported
+        location.href = relativeUrl;
+        return;
+    }
+
+    return loading.show($.get(uri)
+    .done(function (html) {
+        // Push url to history
+        if (push) history.pushState({ path: uri }, null, uri);
+
+        // Replace html content
+        html = html.replace( /<(\/?)(html|head|body)([^>]*)>/ig, function(a,b,c,d){
+            return '<' + b + 'div' + ( b ? '' : ' data-element="' + c + '"' ) + d + '>';
+        });
+
+        var $page = $(html);
+        var $pageHead = $page.find('[data-element=head]');
+        var $pageBody = $page.find('.book');
+
+        // Merge heads
+        // !! Warning !!: we only update necessary portions to avoid strange behavior (page flickering etc ...)
+
+        // Update title
+        document.title = $pageHead.find('title').text();
+
+        // Reference to $('head');
+        var $head = $('head');
+
+        // Update next & prev <link> tags
+        // Remove old
+        $head.find('link[rel=prev]').remove();
+        $head.find('link[rel=next]').remove();
+
+        // Add new next * prev <link> tags
+        $head.append($pageHead.find('link[rel=prev]'));
+        $head.append($pageHead.find('link[rel=next]'));
+
+        // Merge body
+        var bodyClass = $('.book').attr('class');
+        var scrollPosition = $('.book-summary .summary').scrollTop();
+        $pageBody.toggleClass('with-summary', $('.book').hasClass('with-summary'));
+
+        $('.book').replaceWith($pageBody);
+        $('.book').attr('class', bodyClass);
+        $('.book-summary .summary').scrollTop(scrollPosition);
+
+        // Update state
+        state.update($('html'));
+        preparePage();
+    })
+    .fail(function (e) {
+        location.href = relativeUrl;
+    }));
+}
+
+function updateNavigationPosition() {
+    var bodyInnerWidth, pageWrapperWidth;
+
+    bodyInnerWidth = parseInt($('.body-inner').css('width'), 10);
+    pageWrapperWidth = parseInt($('.page-wrapper').css('width'), 10);
+    $('.navigation-next').css('margin-right', (bodyInnerWidth - pageWrapperWidth) + 'px');
+}
+
+function notifyPageChange() {
+    events.trigger('page.change');
+}
+
+function preparePage(notify) {
+    var $bookBody = $('.book-body');
+    var $bookInner = $bookBody.find('.body-inner');
+    var $pageWrapper = $bookInner.find('.page-wrapper');
+
+    // Update navigation position
+    updateNavigationPosition();
+
+    // Focus on content
+    $pageWrapper.focus();
+
+    // Reset scroll
+    $bookInner.scrollTop(0);
+    $bookBody.scrollTop(0);
+
+    // Notify
+    if (notify !== false) notifyPageChange();
+}
+
+function isLeftClickEvent(e) {
+    return e.button === 0;
+}
+
+function isModifiedEvent(e) {
+    return !!(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey);
+}
+
+function handlePagination(e) {
+    if (isModifiedEvent(e) || !isLeftClickEvent(e)) {
+        return;
+    }
+
+    e.stopPropagation();
+    e.preventDefault();
+
+    var url = $(this).attr('href');
+    if (url) handleNavigation(url, true);
+}
+
+function goNext() {
+    var url = $('.navigation-next').attr('href');
+    if (url) handleNavigation(url, true);
+}
+
+function goPrev() {
+    var url = $('.navigation-prev').attr('href');
+    if (url) handleNavigation(url, true);
+}
+
+
+function init() {
+    // Prevent cache so that using the back button works
+    // See: http://stackoverflow.com/a/15805399/983070
+    $.ajaxSetup({
+        cache: false
+    });
+
+    // Recreate first page when the page loads.
+    history.replaceState({ path: window.location.href }, '');
+
+    // Back Button Hijacking :(
+    window.onpopstate = function (event) {
+        if (event.state === null) {
+            return;
+        }
+        return handleNavigation(event.state.path, false);
+    };
+
+    $(document).on('click', '.navigation-prev', handlePagination);
+    $(document).on('click', '.navigation-next', handlePagination);
+    $(document).on('click', '.summary [data-path] a', handlePagination);
+
+    $(window).resize(updateNavigationPosition);
+
+    // Prepare current page
+    preparePage(false);
+}
+
+module.exports = {
+    init: init,
+    goNext: goNext,
+    goPrev: goPrev,
+    notify: notifyPageChange
+};

theme/javascript/platform.js

@@ -0,0 +1,5 @@
+module.exports = {
+    isMobile: function() {
+        return (document.width <= 600);
+    }
+};

theme/javascript/sidebar.js

@@ -0,0 +1,56 @@
+var $ = require('jquery');
+var _ = require('lodash');
+
+var storage = require('./storage');
+var platform = require('./platform');
+var state = require('./state');
+
+
+// Toggle sidebar with or withour animation
+function toggleSidebar(_state, animation) {
+    if (state != null && isOpen() == _state) return;
+    if (animation == null) animation = true;
+
+    state.$book.toggleClass('without-animation', !animation);
+    state.$book.toggleClass('with-summary', _state);
+
+    storage.set('sidebar', isOpen());
+}
+
+// Return true if sidebar is open
+function isOpen() {
+    return state.$book.hasClass('with-summary');
+}
+
+// Prepare sidebar: state and toggle button
+function init() {
+    // Init last state if not mobile
+    if (!platform.isMobile()) {
+        toggleSidebar(storage.get('sidebar', true), false);
+    }
+
+    // Close sidebar after clicking a link on mobile
+    $(document).on('click', '.book-summary li.chapter a', function(e) {
+        if (platform.isMobile()) toggleSidebar(false, false);
+    });
+}
+
+// Filter summary with a list of path
+function filterSummary(paths) {
+    var $summary = $('.book-summary');
+
+    $summary.find('li').each(function() {
+        var path = $(this).data('path');
+        var st = paths == null || _.contains(paths, path);
+
+        $(this).toggle(st);
+        if (st) $(this).parents('li').show();
+    });
+}
+
+module.exports = {
+    init: init,
+    isOpen: isOpen,
+    toggle: toggleSidebar,
+    filter: filterSummary
+};

theme/javascript/state.js

@@ -0,0 +1,38 @@
+var $ = require('jquery');
+var url = require('url');
+var path = require('path');
+
+var state = {};
+
+state.update = function(dom) {
+    var $book = $(dom.find('.book'));
+
+    state.$book = $book;
+    state.level = $book.data('level');
+    state.basePath = $book.data('basepath');
+
+    // If book is multilingual, language of this book
+    state.innerLanguage = $book.data('innerlanguage');
+
+    // Date of build
+    state.revision = $book.data('revision');
+
+    // Original path of the file
+    state.filepath = $book.data('filepath');
+
+    // Title of the chapter
+    state.chapterTitle = $book.data('chapter-title');
+
+    // Absolute url to the root of the book (inner book)
+    state.root = url.resolve(
+        location.protocol+'//'+location.host,
+        path.dirname(path.resolve(location.pathname.replace(/\/$/, '/index.html'), state.basePath))
+    ).replace(/\/?$/, '/');
+
+    // Absolute root to the language (for multilingual book)
+    state.bookRoot = state.innerLanguage? url.resolve(state.root, '..') : state.root;
+};
+
+state.update($);
+
+module.exports = state;

theme/javascript/storage.js

@@ -0,0 +1,37 @@
+var baseKey = '';
+
+/*
+ * Simple module for storing data in the browser's local storage
+ */
+module.exports = {
+    setBaseKey: function(key) {
+        baseKey = key;
+    },
+
+    // Write something in localstorage
+    set: function(key, value) {
+        key = baseKey+':'+key;
+
+        try {
+            localStorage[key] = JSON.stringify(value);
+        } catch(e) {}
+    },
+
+    // Read a value from localstorage
+    get: function(key, def) {
+        key = baseKey+':'+key;
+        if (localStorage[key] === undefined) return def;
+        try {
+            var v = JSON.parse(localStorage[key]);
+            return v == null ? def : v;;
+        } catch(err) {
+            return localStorage[key] || def;
+        }
+    },
+
+    // Remove a key from localstorage
+    remove: function(key) {
+        key = baseKey+':'+key;
+        localStorage.removeItem(key);
+    }
+};

theme/javascript/toolbar.js

@@ -0,0 +1,181 @@
+var $ = require('jquery');
+var _ = require('lodash');
+
+var events = require('./events');
+
+// List of created buttons
+var buttons = [];
+
+// Insert a jquery element at a specific position
+function insertAt(parent, selector, index, element) {
+    var lastIndex = parent.children(selector).size();
+    if (index < 0) {
+        index = Math.max(0, lastIndex + 1 + index);
+    }
+    parent.append(element);
+
+    if (index < lastIndex) {
+        parent.children(selector).eq(index).before(parent.children(selector).last());
+    }
+}
+
+// Default click handler
+function defaultOnClick(e) {
+    e.preventDefault();
+}
+
+// Create a dropdown menu
+function createDropdownMenu(dropdown) {
+    var $menu = $('<div>', {
+        'class': 'dropdown-menu',
+        'html': '<div class="dropdown-caret"><span class="caret-outer"></span><span class="caret-inner"></span></div>'
+    });
+
+    if (_.isString(dropdown)) {
+        $menu.append(dropdown);
+    } else {
+        var groups = _.map(dropdown, function(group) {
+            if (_.isArray(group)) return group;
+            else return [group];
+        });
+
+        // Create buttons groups
+        _.each(groups, function(group) {
+            var $group = $('<div>', {
+                'class': 'buttons'
+            });
+            var sizeClass = 'size-'+group.length;
+
+            // Append buttons
+            _.each(group, function(btn) {
+                btn = _.defaults(btn || {}, {
+                    text: '',
+                    className: '',
+                    onClick: defaultOnClick
+                });
+
+                var $btn = $('<button>', {
+                    'class': 'button '+sizeClass+' '+btn.className,
+                    'text': btn.text
+                });
+                $btn.click(btn.onClick);
+
+                $group.append($btn);
+            });
+
+
+            $menu.append($group);
+        });
+
+    }
+
+
+    return $menu;
+}
+
+// Create a new button in the toolbar
+function createButton(opts) {
+    opts = _.defaults(opts || {}, {
+        // Aria label for the button
+        label: '',
+
+        // Icon to show
+        icon: '',
+
+        // Inner text
+        text: '',
+
+        // Right or left position
+        position: 'left',
+
+        // Other class name to add to the button
+        className: '',
+
+        // Triggered when user click on the button
+        onClick: defaultOnClick,
+
+        // Button is a dropdown
+        dropdown: null,
+
+        // Position in the toolbar
+        index: null
+    });
+
+    buttons.push(opts);
+    updateButton(opts);
+}
+
+// Update a button
+function updateButton(opts) {
+    var $result;
+    var $toolbar = $('.book-header');
+    var $title = $toolbar.find('h1');
+
+    // Build class name
+    var positionClass = 'pull-'+opts.position;
+
+    // Create button
+    var $btn = $('<a>', {
+        'class': 'btn',
+        'text': opts.text? ' ' + opts.text : '',
+        'aria-label': opts.label,
+        'href': '#'
+    });
+
+    // Bind click
+    $btn.click(opts.onClick);
+
+    // Prepend icon
+    if (opts.icon) {
+        $('<i>', {
+            'class': opts.icon
+        }).prependTo($btn);
+    }
+
+    // Prepare dropdown
+    if (opts.dropdown) {
+        var $container = $('<div>', {
+            'class': 'dropdown '+positionClass+' '+opts.className
+        });
+
+        // Add button to container
+        $btn.addClass('toggle-dropdown');
+        $container.append($btn);
+
+        // Create inner menu
+        var $menu = createDropdownMenu(opts.dropdown);
+
+        // Menu position
+        $menu.addClass('dropdown-'+(opts.position == 'right'? 'left' : 'right'));
+
+        $container.append($menu);
+        $result = $container;
+    } else {
+        $btn.addClass(positionClass);
+        $btn.addClass(opts.className);
+        $result = $btn;
+    }
+
+    $result.addClass('js-toolbar-action');
+
+    if (_.isNumber(opts.index) && opts.index >= 0) {
+        insertAt($toolbar, '.btn, .dropdown, h1', opts.index, $result);
+    } else {
+        $result.insertBefore($title);
+    }
+}
+
+// Update all buttons
+function updateAllButtons() {
+    $('.js-toolbar-action').remove();
+    _.each(buttons, updateButton);
+}
+
+// When page changed, reset buttons
+events.bind('page.change', function() {
+    updateAllButtons();
+});
+
+module.exports = {
+    createButton: createButton
+};

theme/javascript/utils/dropdown.js

@@ -1,27 +0,0 @@
-define([
-    "jQuery"
-], function($) {
-
-    var toggleDropdown = function(e) {
-        var $dropdown = $(e.currentTarget).parent().find(".dropdown-menu");
-
-        $dropdown.toggleClass("open");
-        e.stopPropagation();
-        e.preventDefault();
-    };
-
-    var closeDropdown = function(e) {
-        $(".dropdown-menu").removeClass("open");
-    };
-
-    // Bind all dropdown
-    var init = function() {
-        $(document).on('click', ".toggle-dropdown", toggleDropdown);
-        $(document).on('click', ".dropdown-menu", function(e){ e.stopPropagation(); });
-        $(document).on("click", closeDropdown);
-    };
-
-    return {
-        init: init
-    };
-});