Bump version to 0.7.0

Fixes #388

.travis.yml

@@ -2,4 +2,3 @@ language: node_js
 node_js:
   - "0.11"
   - "0.10"
-  - "0.8"

CHANGES.md

@@ -1,2 +1,12 @@
 # Release notes
 
+## 0.6.2
+- Support generating a plugin's book info dynamically
+- Improve navigation on dark theme
+- Improve path normalization when parsing SUMMARY.md
+
+## 0.6.0
+- Generate header id the same as github
+- Custom links can be added at top of sidebar
+- Summary can now be transformed by plugins
+- Support importing code snippets

Gruntfile.js

@@ -24,8 +24,8 @@ module.exports = function (grunt) {
                     optimization: 2
                 },
                 files: {
-                    "theme/assets/style.css": "theme/stylesheets/main.less",
-                    "theme/assets/print.css": "theme/stylesheets/print.less"
+                    "theme/assets/style.css": "theme/stylesheets/website.less",
+                    "theme/assets/print.css": "theme/stylesheets/ebook.less"
                 }
             }
         },
@@ -44,7 +44,8 @@ module.exports = function (grunt) {
                         "requireLib": 'vendors/requirejs/require',
                         "Mousetrap": 'vendors/mousetrap/mousetrap',
                         "lunr": 'vendors/lunr.js/lunr',
-                        "URI": 'vendors/URIjs/src/URI'
+                        "URI": 'vendors/URIjs/src/URI',
+                        "ace": 'vendors/ace-builds/src-noconflict/'
                     },
                     shim: {
                         'jQuery': {

README.md

@@ -3,7 +3,7 @@ GitBook
 
 [![Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
 
-GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
+GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. Here is an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). You can publish book easily online using [gitbook.io](https://www.gitbook.io) and an [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
 
 ![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
 
@@ -31,26 +31,36 @@ Options for commands `build` and `serve` are:
 
 ```
 -o, --output <directory>  Path to output directory, defaults to ./_book
--f, --format <name>       Change generation format, defaults to site, availables are: site, page, pdf, json, mobi, epub
---config <config file>    Configuration file to use, defaults to book.json
+-f, --format <name>       Change generation format, defaults to site, availables are: site, page, ebook, json
+--config <config file>    Configuration file to use, defaults to book.js or book.json
 ```
 
 GitBook loads the default configuration from a `book.json` file in the repository if it exists.
 
 Here are the options that can be stored in this file:
 
-```
+```js
 {
-    // Folders to use for output (caution: it overrides the value from the command line)
+    // Folders to use for output
+    // Caution: it overrides the value from the command line
+    // It's not advised this option in the book.json
     "output": null,
 
-    // Generator to use for building (caution: it overrides the value from the command line)
+    // Generator to use for building
+    // Caution: it overrides the value from the command line
+    // It's not advised this option in the book.json
     "generator": "site",
 
     // Book title and description (defaults are extracted from the README)
     "title": null,
     "description": null,
 
+    // For ebook format, the extension to use for generation (default is detected from output extension)
+    // "epub", "pdf", "mobi"
+    // Caution: it overrides the value from the command line
+    // It's not advised this option in the book.json
+    "extension": null,
+
     // GitHub information (defaults are extracted using git)
     "github": null,
     "githubHost": "https://github.com/",
@@ -82,12 +92,43 @@ Here are the options that can be stored in this file:
         "issues": null,
         "contribute": null,
 
+    	// Custom links at top of sidebar
+    	"custom": {
+    	    "Custom link name": "https://customlink.com"
+    	},
+
         // Sharing links
         "sharing": {
             "google": null,
             "facebook": null,
             "twitter": null
         }
+    },
+
+
+    // Options for PDF generation
+    "pdf": {
+        // Add toc at the end of the file
+        "toc": true,
+
+        // Add page numbers to the bottom of every page
+        "pageNumbers": false,
+
+        // Font size for the fiel content
+        "fontSize": 12,
+
+        // Paper size for the pdf
+        // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
+        "paperSize": "a4",
+
+        // Margin (in pts)
+        // Note: 72 pts equals 1 inch
+        "margin": {
+            "right": 62,
+            "left": 62,
+            "top": 36,
+            "bottom": 36
+        }
     }
 }
 ```
@@ -217,3 +258,14 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
 * [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages
 * [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook
 * [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik): Piwik Open Analytics tracking for your book
+* [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors): Add linkable Github-style anchors to headings
+* [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin): Ebedded jsbin frame into your book
+
+#### Debugging
+
+You can use the environment variable `DEBUG=true` to get better error messages (with stack trace). For example:
+
+```
+$ export DEBUG=true
+$ gitbook build ./
+```

bin/build.js

@@ -10,9 +10,10 @@ var generators = require("../lib/generate").generators;
 
 var buildCommand = function(command) {
     return command
+    .option('-v, --verbose', 'Activate verbose mode, useful for debugging errors')
     .option('-o, --output <directory>', 'Path to output directory, defaults to ./_book')
     .option('-f, --format <name>', 'Change generation format, defaults to site, availables are: '+_.keys(generators).join(", "))
-    .option('--config <config file>', 'Configuration file to use, defualt to book.json')
+    .option('--config <config file>', 'Configuration file to use, defaults to book.js or book.json');
 };
 
 
@@ -26,6 +27,11 @@ var makeBuildFunc = function(converter) {
         dir = dir || process.cwd();
         outputDir = options.output;
 
+        // Set debugging
+        if(options.verbose) {
+            process.env.DEBUG = "true";
+        }
+
         console.log('Starting build ...');
         return converter(
             _.extend({}, options || {}, {
@@ -36,10 +42,14 @@ var makeBuildFunc = function(converter) {
             })
         )
         .then(function(output) {
-            console.log("Successfuly built !");
+            console.log("Successfully built!");
             return output;
-        }, utils.logError)
-        .fail(function() {
+        })
+        .fail(function(err) {
+            // Log error
+            utils.logError(err);
+
+            // Exit process with failure code
             process.exit(-1);
         });
     };

bin/gitbook.js

@@ -14,6 +14,7 @@ var fs = require('../lib/generate/fs');
 var utils = require('./utils');
 var build = require('./build');
 var Server = require('./server');
+var platform = require("./platform");
 
 // General options
 prog
@@ -80,17 +81,6 @@ build.command(prog.command('serve [source_dir]'))
     generate();
 });
 
-build.commandEbook(prog.command('ebook [source_dir]'))
-.description('Build a gitbook as a eBook (format detected according to the extension)')
-.action(function(dir, options) {
-    var ext = options.output ? path.extname(options.output) : "epub";
-
-    build.file(dir, _.extend(options, {
-        extension: ext,
-        format: "ebook"
-    }));
-});
-
 build.commandEbook(prog.command('pdf [source_dir]'))
 .description('Build a gitbook as a PDF')
 .action(function(dir, options) {
@@ -126,6 +116,22 @@ prog
     return initDir(dir);
 });
 
+prog
+.command('publish [source_dir]')
+.description('Publish content to the associated gitbook.io book')
+.action(function(dir) {
+    dir = dir || process.cwd();
+    return platform.publish(dir);
+});
+
+prog
+.command('git:remote [source_dir] [book_id]')
+.description('Adds a git remote to a book repository')
+.action(function(dir, bookId) {
+    dir = dir || process.cwd();
+    return platform.remote(dir, bookId);
+});
+
 // Parse and fallback to help if no args
 if(_.isEmpty(prog.parse(process.argv).args) && process.argv.length === 2) {
     prog.help();

bin/platform.js

@@ -0,0 +1,53 @@
+var Q = require("q");
+var utils = require("./utils");
+
+var publish = function(folder) {
+    if (!folder) {
+        console.log("Need a repository folder");
+        return process.exit(-1);
+    }
+
+    utils.gitCmd("push", ["gitbook", "master"])
+    .then(function(out) {
+        console.log(out.stdout);
+    }, function(err) {
+        if (err.code == 128) {
+            console.log("No book on gitbook.io is configured with this git repository.");
+            console.log("Run 'gitbook git:remote username/book' to intialize this repository.");
+        } else {
+            console.log(err.message);
+        }
+        process.exit(-1);
+    });
+};
+
+var remote = function(folder, bookId) {
+    if (!folder || !bookId) {
+        console.log("Need a repository folder and a book id");
+        return process.exit(-1);
+    }
+
+    var url = "https://push.gitbook.io/"+bookId+".git";
+    var addRemote = function() {
+        return utils.gitCmd("remote", ["add", "gitbook", url]);
+    }
+
+    addRemote()
+    .fail(function(err) {
+        if (err.code == 128) {
+            return utils.gitCmd("remote", ["rm", "gitbook"]).then(addRemote);
+        }
+        return Q.reject(err);
+    })
+    .then(function(out) {
+        console.log("Book remote '"+url+"' added to the folder");
+    }, function(err) {
+        console.log(err.message);
+        process.exit(-1);
+    });
+};
+
+module.exports = {
+    publish: publish,
+    remote: remote
+};

bin/utils.js

@@ -1,6 +1,7 @@
 var Q = require('q');
 var _ = require('lodash');
 
+var exec = require('child_process').exec;
 var http = require('http');
 var send = require('send');
 
@@ -36,9 +37,30 @@ function logError(err) {
     return Q.reject(err);
 };
 
+function runGitCommand(command, args) {
+    var d = Q.defer(), child;
+    args = ["git", command].concat(args).join(" ");
+
+    child = exec(args, function (error, stdout, stderr) {
+        if (error !== null) {
+            error.stdout = stdout;
+            error.stderr = stderr;
+            d.reject(error);
+        } else {
+            d.resolve({
+                stdout: stdout,
+                stderr: stderr
+            })
+        }
+    });
+
+    return d.promise;
+};
+
 
 // Exports
 module.exports = {
     watch: watch,
-    logError: logError
+    logError: logError,
+    gitCmd: runGitCommand
 };

bower.json

@@ -7,6 +7,7 @@
         "requirejs": "2.1.11",
         "URIjs": "1.13.1",
         "mousetrap": "1.4.6",
-        "lunr.js": "0.5.2"
+        "lunr.js": "0.5.2",
+        "ace-builds": "1.1.3"
     }
 }

lib/generate/ebook/index.js

@@ -4,7 +4,7 @@ var Q = require("q");
 var _ = require("lodash");
 var exec = require('child_process').exec;
 
-var fs = require("fs");
+var fs = require('graceful-fs');
 var parse = require("../../parse");
 var BaseGenerator = require("../page");
 var stringUtils = require("../../utils/string");
@@ -15,11 +15,6 @@ var stringUtils = require("../../utils/string");
  */
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
-
-    // Options for eBook generation
-    this.options = _.defaults(this.options, {
-        extension: "epub"
-    });
 };
 util.inherits(Generator, BaseGenerator);
 
@@ -29,7 +24,7 @@ Generator.prototype.finish = function() {
     return BaseGenerator.prototype.finish.apply(this)
     .then(function() {
         var d = Q.defer();
-        var format = that.options.extension || path.extname(that.options.output);
+        var format = that.options.extension || path.extname(that.options.output).replace("\.", "") || "pdf";
 
         if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
             that.options.cover = path.join(that.options.output, "cover.jpg");
@@ -40,27 +35,45 @@ Generator.prototype.finish = function() {
             "--title": that.options.title,
             "--comments": that.options.description,
             "--authors": that.options.author,
+            "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
+            "--chapter-mark": "pagebreak",
             "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
             "--level2-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-2 ')]",
-            "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]"
+            "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]",
+            "--no-chapters-in-toc": true
         };
 
         if (format == "pdf") {
+            var pdfOptions = _.defaults(that.options.pdf || {}, {
+                "fontSize": 12,
+                "toc": true,
+                "pageNumbers": false,
+                "paperSize": "a4",
+                "margin": {
+                    "right": 62,
+                    "left": 62,
+                    "top": 36,
+                    "bottom": 36
+                }
+            });
+
             _.extend(_options, {
-                "--margin-left": "62",
-                "--margin-right": "62",
-                "--margin-top": "36",
-                "--margin-bottom": "36",
-                "--pdf-add-toc": true,
-                "--pdf-default-font-size": "12",
-                "--paper-size": "a4",
+                "--margin-left": String(pdfOptions.margin.left),
+                "--margin-right": String(pdfOptions.margin.right),
+                "--margin-top": String(pdfOptions.margin.top),
+                "--margin-bottom": String(pdfOptions.margin.bottom),
+                "--pdf-add-toc": Boolean(pdfOptions.toc),
+                "--pdf-default-font-size": String(pdfOptions.fontSize),
+                "--pdf-mono-font-size": String(pdfOptions.fontSize),
+                "--paper-size": String(pdfOptions.paperSize),
+                "--pdf-page-numbers": Boolean(pdfOptions.pageNumbers)
             });
         }
 
         var command = [
             "ebook-convert",
             path.join(that.options.output, "index.html"),
-            path.join(that.options.output, "index."+that.options.extension),
+            path.join(that.options.output, "index."+format),
             stringUtils.optionsToShellArgs(_options)
         ].join(" ");
 

lib/generate/fs.js

@@ -1,5 +1,5 @@
 var Q = require("q");
-var fs = require("fs");
+var fs = require('graceful-fs');
 var fsExtra = require("fs-extra");
 var Ignore = require("fstream-ignore");
 
@@ -16,9 +16,25 @@ var getFiles = function(path) {
 
     // Add extra rules to ignore common folders
     ig.addIgnoreRules([
+        // Skip Git stuff
         '.git/',
         '.gitignore',
-        '.DS_Store'
+
+        // Skip OS X meta data
+        '.DS_Store',
+
+        // Skip stuff installed by plugins
+        'node_modules',
+
+        // Skip book outputs
+        '*.pdf',
+        '*.epub',
+        '*.mobi',
+
+        // Skip config files
+        '.ignore',
+        '.bookignore',
+        'book.json',
     ], '__custom_stuff');
 
     // Push each file to our list

lib/generate/generator.js

@@ -14,13 +14,13 @@ var BaseGenerator = function(options) {
 };
 
 BaseGenerator.prototype.callHook = function(name, data) {
-    return this.plugins.hook(name, this, data);
+    return this.plugins.hook(name, data);
 };
 
 BaseGenerator.prototype.loadPlugins = function() {
     var that = this;
 
-    return Plugin.fromList(this.options.plugins, this.options.input)
+    return Plugin.fromList(this.options.plugins, this.options.input, this)
     .then(function(_plugins) {
         that.plugins = _plugins;
 
@@ -45,6 +45,27 @@ BaseGenerator.prototype.transferFolder = function(input) {
     );
 };
 
+BaseGenerator.prototype.copyCover = function() {
+    var that = this;
+
+    return Q.all([
+        fs.copy(path.join(this.options.input, "cover.jpg"), path.join(this.options.output, "cover.jpg")),
+        fs.copy(path.join(this.options.input, "cover_small.jpg"), path.join(this.options.output, "cover_small.jpg"))
+    ])
+    .fail(function() {
+        // If orignally from multi-lang, try copy from originalInput
+        if (!that.options.originalInput) return;
+
+        return Q.all([
+            fs.copy(path.join(that.options.originalInput, "cover.jpg"), path.join(that.options.output, "cover.jpg")),
+            fs.copy(path.join(that.options.originalInput, "cover_small.jpg"), path.join(that.options.output, "cover_small.jpg"))
+        ]);
+    })
+    .fail(function(err) {
+        return Q();
+    });
+};
+
 BaseGenerator.prototype.langsIndex = function(langs) {
     return Q.reject(new Error("Langs index is not supported in this generator"));
 };

lib/generate/index.js

@@ -1,9 +1,9 @@
 var Q = require("q");
 var _ = require("lodash");
 var path = require("path");
-var swig = require('swig');
 var tmp = require('tmp');
 
+var swig = require('./template');
 var fs = require("./fs");
 var parse = require("../parse");
 var Plugin = require("./plugin");
@@ -25,13 +25,23 @@ var containsFiles = function(dir, files) {
     .then(_.all);
 };
 
+// TEst if generator exists
+var checkGenerator = function(options) {
+    if (!generators[options.generator]) {
+        return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")+")"));
+    }
+    return Q();
+};
 
 // Create the generator and load plugins
 var loadGenerator = function(options) {
-    var generator = new generators[options.generator](options);
+    return checkGenerator(options)
+    .then(function() {
+        var generator = new generators[options.generator](options);
 
-    return generator.loadPlugins()
-    .then(_.constant(generator));
+        return generator.loadPlugins()
+        .then(_.constant(generator));
+    });
 };
 
 
@@ -44,7 +54,7 @@ var generate = function(options) {
         "output": null,
 
         // Config file (relative to input)
-        "configFile": "book.json",
+        "configFile": "book",
 
         // Output generator
         "generator": "site",
@@ -78,27 +88,20 @@ var generate = function(options) {
         return Q.reject(new Error("Need option input (book input directory)"));
     }
 
-    // Ensure generator exists
-    if (!generators[options.generator]) {
-        return Q.reject(new Error("Invalid generator (availables are: "+_.keys(generators).join(", ")));
-    }
-
     // Check files to get folder type (book, multilanguage book or neither)
-    return Q()
+    return checkGenerator(options)
 
     // Read config file
     .then(function() {
-        return fs.readFile(path.resolve(options.input, options.configFile))
-        .then(function(_config) {
-            // Extend current config
-            _config = JSON.parse(_config);
-            _config = _.omit(_config, 'input', 'configFile', 'defaultsPlugins');
+        try {
+            var _config = require(path.resolve(options.input, options.configFile));
 
-            _.extend(options, _config);
-        }, function() {
+            _.extend(options, _.omit(_config, 'input', 'configFile', 'defaultsPlugins'));
+        }
+        catch(err) {
             // No config file: not a big deal
             return Q();
-        });
+        }
     })
 
     // Read readme
@@ -133,8 +136,12 @@ var generateMultiLang = function(options) {
     var langsSummary;
     options.output = options.output || path.join(options.input, "_book");
 
+    return checkGenerator(options)
+
     // Multi-languages book
-    return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
+    .then(function() {
+        return fs.readFile(path.join(options.input, "LANGS.md"), "utf-8")
+    })
 
     // Clean output folder
     .then(function(_langsSummary) {
@@ -154,7 +161,9 @@ var generateMultiLang = function(options) {
             return prev.then(function() {
                 return generate(_.extend({}, options, {
                     input: path.join(options.input, entry.path),
-                    output: path.join(options.output, entry.path)
+                    output: path.join(options.output, entry.path),
+                    originalInput: options.input,
+                    originalOutput: options.output
                 }));
             })
         }, Q());
@@ -169,6 +178,17 @@ var generateMultiLang = function(options) {
         return generator.langsIndex(options.langsSummary);
     })
 
+    // Copy cover file
+    .then(function() {
+        return Q.all([
+            fs.copy(path.join(options.input, "cover.jpg"), path.join(options.output, "cover.jpg")),
+            fs.copy(path.join(options.input, "cover_small.jpg"), path.join(options.output, "cover_small.jpg"))
+        ])
+        .fail(function() {
+            return Q();
+        })
+    })
+
     // Return options to caller
     .then(_.constant(options));
 };
@@ -204,8 +224,15 @@ var generateBook = function(options) {
             options.github = null;
             return null;
         } else if(options.github) {
-        // Git already specified in options
-            return options.github;
+            // Git already specified in options
+            options.github = (
+                // Support URLs in "github" entry of book.json
+                parse.git.githubID(options.github) ||
+
+                // Fallback
+                options.github
+            );
+            return;
         }
 
         // Try auto detecting
@@ -244,13 +271,31 @@ var generateBook = function(options) {
 
         // Get summary
         .then(function() {
-            return fs.readFile(path.join(options.input, "SUMMARY.md"), "utf-8")
-            .then(function(_summary) {
-                options.summary = parse.summary(_summary);
+            var summary = {
+                path: path.join(options.input, "SUMMARY.md")
+            };
 
-                // Parse navigation
-                options.navigation = parse.navigation(options.summary);
-            });
+            var _callHook = function(name) {
+                return generator.callHook(name, summary)
+                .then(function(_summary) {
+                    summary = _summary;
+                    return summary;
+                });
+            };
+
+            return fs.readFile(summary.path, "utf-8")
+                .then(function(_content) {
+                    summary.content = _content;
+                    return _callHook("summary:before");
+                })
+                .then(function() {
+                    summary.content = parse.summary(summary.content);
+                    return _callHook("summary:after");
+                })
+                .then(function() {
+                    options.summary = summary.content;
+                    options.navigation = parse.navigation(options.summary);
+                })
         })
 
         // Skip processing some files

lib/generate/page/index.js

@@ -2,27 +2,12 @@ var _ = require("lodash");
 var util = require("util");
 var path = require("path");
 var Q = require("q");
-var swig = require('swig');
-var hljs = require('highlight.js');
+var swig = require("../template");
 
 var fs = require("../fs");
 var parse = require("../../parse");
 var BaseGenerator = require("../site");
 
-// Swig filter: highlight coloration
-swig.setFilter('code', function(code, lang) {
-    try {
-        return hljs.highlight(lang, code).value;
-    } catch(e) {
-        return hljs.highlightAuto(code).value;
-    }
-});
-
-// Convert a level into a deep level
-swig.setFilter('lvl', function(lvl) {
-    return lvl.split(".").length;
-});
-
 
 /*
  *  This generator will generate a simple index.html which can be converted as a PDF
@@ -66,6 +51,11 @@ Generator.prototype.convertFile = function(content, input) {
     });
 };
 
+// Generate languages index
+Generator.prototype.langsIndex = function(langs) {
+    return Q();
+};
+
 Generator.prototype.finish = function() {
     var that = this;
     var basePath = ".";
@@ -85,6 +75,11 @@ Generator.prototype.finish = function() {
         }, output);
     })
 
+    // Copy cover
+    .then(function() {
+        return that.copyCover();
+    })
+
     // Copy assets
     .then(function() {
         return fs.copy(

lib/generate/plugin.js

@@ -10,11 +10,15 @@ var pkg = require("../../package.json");
 
 var  RESOURCES = ["js", "css"];
 
-var Plugin = function(name, root) {
+var Plugin = function(name, root, generator) {
     this.name = name;
     this.root = root;
     this.packageInfos = {};
     this.infos = {};
+    this.generator = generator;
+
+    // Bind methods
+    _.bindAll(this);
 
     _.each([
         "gitbook-plugin-"+name,
@@ -43,28 +47,67 @@ Plugin.prototype.load = function(name, baseDir) {
     }
 };
 
-// Return resources
-Plugin.prototype.getResources = function(resource) {
-    if (!this.infos.book || !this.infos.book[resource]) {
-        return [];
+Plugin.prototype.normalizeResource = function(resource) {
+    // Parse the resource path
+    var parsed = url.parse(resource);
+
+    // This is a remote resource
+    // so we will simply link to using it's URL
+    if (parsed.protocol) {
+        return {
+            "url": resource
+        };
     }
-    return _.chain(this.infos.book[resource])
-    .map(function(resource) {
-        var parsed = url.parse(resource);
-        if (parsed.protocol) return {"url": resource}
-        else return { "path": this.name+"/"+resource };
-    }.bind(this))
-    .value();
+
+    // This will be copied over from disk
+    // and shipped with the book's build
+    return { "path": this.name+"/"+resource };
+};
+
+// Return resources
+Plugin.prototype._getResources = function() {
+    var book = this.infos.book;
+
+    // Nothing specified, fallback to default
+    if (!book) {
+        return Q({});
+    }
+
+    // Dynamic function
+    if(typeof book === "function") {
+        // Call giving it the context of our generator
+        return Q().then(book.bind(this.generator));
+    }
+
+    // Plain data object
+    return Q(_.cloneDeep(book));
+};
+
+// Normalize resources and return them
+Plugin.prototype.getResources = function() {
+    var that = this;
+
+
+
+    return this._getResources()
+    .then(function(resources) {
+
+        _.each(RESOURCES, function(resourceType) {
+            resources[resourceType] = (resources[resourceType] || []).map(that.normalizeResource);
+        });
+
+        return resources;
+    });
 };
 
 // Test if it's a valid plugin
 Plugin.prototype.isValid = function() {
     return (
-        this.packageInfos
-        && this.packageInfos.name
-        && this.packageInfos.engines
-        && this.packageInfos.engines.gitbook
-        && semver.satisfies(pkg.version, this.packageInfos.engines.gitbook)
+        this.packageInfos &&
+        this.packageInfos.name &&
+        this.packageInfos.engines &&
+        this.packageInfos.engines.gitbook &&
+        semver.satisfies(pkg.version, this.packageInfos.engines.gitbook)
     );
 };
 
@@ -74,7 +117,10 @@ Plugin.prototype.resolveFile = function(filename) {
 };
 
 // Resolve file path
-Plugin.prototype.callHook = function(name, context, data) {
+Plugin.prototype.callHook = function(name, data) {
+    // Our generator will be the context to apply
+    var context = this.generator;
+
     var hookFunc = this.infos.hooks? this.infos.hooks[name] : null;
     data = data || {};
 
@@ -86,18 +132,20 @@ Plugin.prototype.callHook = function(name, context, data) {
     });
 };
 
-// Has assets
-Plugin.prototype.hasAssets = function(out) {
-    return (this.infos.book && this.infos.book.assets);
-};
-
 // Copy plugin assets fodler
 Plugin.prototype.copyAssets = function(out) {
-    if (!this.hasAssets()) return Q();
-    return fs.copy(
-        this.resolveFile(this.infos.book.assets),
-        out
-    );
+    var that = this;
+
+    return this.getResources().get('assets')
+    .then(function(assets) {
+        // Assets are undefined
+        if(!assets) return false;
+
+        return fs.copy(
+            that.resolveFile(assets),
+            out
+        ).then(_.constant(true));
+    }, _.constant(false));
 };
 
 
@@ -114,7 +162,7 @@ Plugin.normalizeNames = function(names) {
         return name.length > 0 && name[0] == "-";
     })
     .map(function(name) {
-        return name.slice(1)
+        return name.slice(1);
     })
     .value();
 
@@ -133,74 +181,98 @@ Plugin.normalizeNames = function(names) {
 };
 
 // Extract data from a list of plugin
-Plugin.fromList = function(names, root) {
+Plugin.fromList = function(names, root, generator) {
     var failed = [];
 
     // Load plugins
     var plugins = _.map(names, function(name) {
-        var plugin = new Plugin(name, root);
+        var plugin = new Plugin(name, root, generator);
         if (!plugin.isValid()) failed.push(name);
         return plugin;
     });
 
     if (_.size(failed) > 0) return Q.reject(new Error("Error loading plugins: "+failed.join(",")));
 
-    // Get all resources
-    var resources = _.chain(RESOURCES)
-    .map(function(resource) {
-        return [
-            resource,
-            _.chain(plugins)
-            .map(function(plugin) {
-                return plugin.getResources(resource);
-            })
-            .flatten()
-            .value()
-        ];
-    })
-    .object()
-    .value();
-    resources.html = {}
+    // The raw resources extracted from each plugin
+    var pluginResources;
 
-    _.each(plugins, function(plugin) {
-        var html = plugin.infos.book.html || {};
-        _.each(html, function(code, key) {
-            if (!_.isFunction(code)) code = _.constant(code);
-            if (!resources.html[key]) resources.html[key] = [];
-            resources.html[key].push(code);
+    // Get resources of plugins
+    return Q.all(_.map(plugins, function(plugin) {
+        return plugin.getResources();
+    }))
+    // Extract resources out
+    // css, js, etc ...
+    .then(function(resources) {
+        pluginResources = resources;
+        // Group by resource types
+        return _.chain(RESOURCES)
+        .map(function(resourceType) {
+            // Get resources from all the plugins for this current type
+            return [
+                // Key
+                resourceType,
+                // Value
+                _.chain(resources)
+                .pluck(resourceType)
+                .compact()
+                .flatten()
+                .value()
+            ];
         })
-    });
-
-    return Q({
-        'list': plugins,
-        'resources': resources,
-        'hook': function(name, context, data) {
-            return _.reduce(plugins, function(prev, plugin) {
-                return prev.then(function(ret) {
-                    return plugin.callHook(name, context, ret);
-                })
-            }, Q(data));
-        },
-        'template': function(name) {
-            var withTpl = _.find(plugins, function(plugin) {
-                return (plugin.infos.templates
-                    && plugin.infos.templates[name]);
+        .object()
+        .value();
+    })
+    // Extract html snippets
+    .then(function(resources) {
+        // Map of html resources by name added by each plugin
+        resources.html = pluginResources.reduce(function(accu, resource) {
+            var html = (resource && resource.html) || {};
+            _.each(html, function(code, key) {
+                // Turn into function if not one already
+                if (!_.isFunction(code)) code = _.constant(code);
+                // Append
+                accu[key] = (accu[key] || []).concat([code]);
             });
 
-            if (!withTpl) return null;
-            return withTpl.resolveFile(withTpl.infos.templates[name]);
-        },
-        'html': function(tag, context, options) {
-            return _.map(resources.html[tag] || [], function(code) {
-                return code.call(context, options);
-            }).join("\n");
-        }
+            return accu;
+        }, {});
+
+        return resources;
+    })
+    // Return big multi-plugin object
+    .then(function(resources) {
+        return {
+            'list': plugins,
+            'resources': resources,
+            'hook': function(name, data) {
+                return _.reduce(plugins, function(prev, plugin) {
+                    return prev.then(function(ret) {
+                        return plugin.callHook(name, ret);
+                    });
+                }, Q(data));
+            },
+            'template': function(name) {
+                var withTpl = _.find(plugins, function(plugin) {
+                    return (
+                        plugin.infos.templates &&
+                        plugin.infos.templates[name]
+                    );
+                });
+
+                if (!withTpl) return null;
+                return withTpl.resolveFile(withTpl.infos.templates[name]);
+            },
+            'html': function(tag, context, options) {
+                return _.map(resources.html[tag] || [], function(code) {
+                    return code.call(context, options);
+                }).join("\n");
+            }
+        };
     });
 };
 
 // Default plugins
 Plugin.defaults = [
-    "mixpanel",
     "mathjax"
 ];
 

lib/generate/site/index.js

@@ -2,26 +2,16 @@ var util = require("util");
 var path = require("path");
 var Q = require("q");
 var _ = require("lodash");
-var swig = require('swig');
+var swig = require("../template");
 
 var fs = require("../fs");
 var parse = require("../../parse");
 var BaseGenerator = require("../generator");
-
+var links = require("../../utils/links");
 var indexer = require('./search_indexer');
 var Manifest = require('../manifest');
 
-// Swig filter for returning the count of lines in a code section
-swig.setFilter('lines', function(content) {
-    return content.split('\n').length;
-});
 
-// Swig filter for returning a link to the associated html file of a markdown file
-swig.setFilter('mdLink', function(link) {
-    var link = link.replace(".md", ".html");
-    if (link == "README.html") link = "index.html";
-    return link;
-});
 
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
@@ -112,6 +102,7 @@ Generator.prototype.convertFile = function(content, _input) {
 
     var page = {
         path: _input,
+	rawPath: input, // path to raw md file
         content: content,
         progress: parse.progress(this.options.navigation, _input)
     };
@@ -162,7 +153,7 @@ Generator.prototype.convertFile = function(content, _input) {
             content: page.sections,
 
             basePath: basePath,
-            staticBase: path.join(basePath, "gitbook"),
+            staticBase: links.join(basePath, "gitbook"),
         }, output, function(html) {
             page.content = html;
 
@@ -198,7 +189,7 @@ Generator.prototype.copyAssets = function() {
         path.join(that.options.output, "gitbook")
     )
 
-    // Add to cach manifest
+    // Add to cache manifest
     .then(function() {
         return that.manifest.addFolder(path.join(that.options.output, "gitbook"), "gitbook");
     })
@@ -207,16 +198,16 @@ Generator.prototype.copyAssets = function() {
     .then(function() {
         return Q.all(
             _.map(that.plugins.list, function(plugin) {
-                if (!plugin.hasAssets()) return Q();
-
                 var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name);
                 return plugin.copyAssets(pluginAssets)
-                .then(function() {
+                .then(function(copiedStuff) {
+                    // Nothing was copied
+                    if(!copiedStuff) { return; }
                     return that.manifest.addFolder(pluginAssets, "gitbook/plugins/"+plugin.name);
                 });
             })
         );
-    })
+    });
 };
 
 // Dump search index to disk
@@ -237,7 +228,9 @@ Generator.prototype.writeCacheManifest = function() {
 };
 
 Generator.prototype.finish = function() {
-    var deferred = this.copyAssets().then(this.writeSearchIndex);
+    var deferred = this.copyAssets()
+    .then(this.copyCover)
+    .then(this.writeSearchIndex);
 
     if (this.options.cache !== false) {
         deferred = deferred.then(this.writeCacheManifest);

lib/generate/site/search_indexer.js

@@ -2,7 +2,7 @@ var Q = require("q");
 var _ = require("lodash");
 
 var lunr = require('lunr');
-var marked = require('marked');
+var kramed = require('kramed');
 var textRenderer = require('marked-text-renderer');
 
 
@@ -28,14 +28,14 @@ Indexer.prototype.text = function(nodes) {
     // Copy section
     var section = _.toArray(nodes);
 
-    // marked's Render expects this, we don't use it yet
+    // kramed's Render expects this, we don't use it yet
     section.links = {};
 
-    var options = _.extend({}, marked.defaults, {
+    var options = _.extend({}, kramed.defaults, {
         renderer: this.renderer
     });
 
-    return marked.parser(section, options);
+    return kramed.parser(section, options);
 };
 
 Indexer.prototype.addSection = function(path, section) {

lib/generate/template.js

@@ -0,0 +1,52 @@
+var path = require("path");
+var swig = require('swig');
+var hljs = require('highlight.js');
+
+var links = require('../utils/').links;
+var pkg = require('../../package.json');
+
+swig.setDefaults({
+    locals: {
+        gitbook: {
+            version: pkg.version
+        }
+    }
+});
+
+// Swig filter for returning the count of lines in a code section
+swig.setFilter('lines', function(content) {
+    return content.split('\n').length;
+});
+
+// Swig filter for returning a link to the associated html file of a markdown file
+swig.setFilter('mdLink', function(link) {
+    var link = link.replace(".md", ".html");
+    if (link == "README.html") link = "index.html";
+    return link;
+});
+
+// Swig filter: highlight coloration
+swig.setFilter('code', function(code, lang) {
+    try {
+        return hljs.highlight(lang, code).value;
+    } catch(e) {
+        return hljs.highlightAuto(code).value;
+    }
+});
+
+// Convert a level into a deep level
+swig.setFilter('lvl', function(lvl) {
+    return lvl.split(".").length;
+});
+
+// Join path
+swig.setFilter('pathJoin', function(base, _path) {
+    return path.join(base, _path);
+});
+
+// Is a link an absolute link
+swig.setFilter('isExternalLink', function(link) {
+    return links.isExternal(link);
+});
+
+module.exports = swig;

lib/parse/code_include.js

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

lib/parse/git.js

@@ -28,7 +28,7 @@ function gitURL(path) {
 // Parse a git URL to a github ID : username/reponame
 function githubID(_url) {
     // Remove .git if it's in _url
-    var sliceEnd = _url.slice(-4) === '.git' ? -4 : _url.length;
+    var sliceEnd = _url.slice(-4) === '.git' ? -4 : undefined;
 
     // Detect HTTPS repos
     var parsed = url.parse(_url);

lib/parse/langs.js

@@ -1,13 +1,14 @@
-var _ = require("lodash")
-var parseSummary = require("./summary");
+var _ = require("lodash");
+var parseEntries = require("./summary").entries;
+
 
 var parseLangs = function(content) {
-    var summary = parseSummary(content);
+    var entries = parseEntries(content);
 
     return {
-        list: _.chain(summary.chapters)
+        list: _.chain(entries)
             .filter(function(entry) {
-                return entry.path != null;
+                return Boolean(entry.path);
             })
             .map(function(entry) {
                 return {
@@ -17,7 +18,8 @@ var parseLangs = function(content) {
                 };
             })
             .value()
-    }
+    };
 };
 
+
 module.exports = parseLangs;

lib/parse/lex.js

@@ -1,5 +1,5 @@
 var _ = require('lodash');
-var marked = require('marked');
+var kramed = require('kramed');
 
 // Split a page up into sections (lesson, exercises, ...)
 function splitSections(nodes) {
@@ -88,7 +88,7 @@ function sectionId(section, idx) {
 
 function lexPage(src) {
     // Lex file
-    var nodes = marked.lexer(src);
+    var nodes = kramed.lexer(src);
 
     return _.chain(splitSections(nodes))
     .map(function(section, idx) {
@@ -118,6 +118,10 @@ function lexPage(src) {
 
         return sections;
     }, [])
+    .map(function(section) {
+        section.links = nodes.links;
+        return section;
+    })
     .value();
 }
 

lib/parse/navigation.js

@@ -26,15 +26,9 @@ function navigation(summary, files) {
     // Support single files as well as list
     files = _.isArray(files) ? files : (_.isString(files) ? [files] : null);
 
-    // Special README nav
-    var README_NAV = {
-        path: 'README.md',
-        title: 'Introduction',
-        level: '0',
-    };
-
     // List of all navNodes
-    var navNodes = [README_NAV].concat(flattenChapters(summary.chapters));
+    // Flatten chapters, then add in default README node if ndeeded etc ...
+    var navNodes = flattenChapters(summary.chapters);
     var prevNodes = [null].concat(navNodes.slice(0, -1));
     var nextNodes = navNodes.slice(1).concat([null]);
 

lib/parse/page.js

@@ -1,10 +1,11 @@
 var _ = require('lodash');
-var marked = require('marked');
+var kramed = require('kramed');
 var hljs = require('highlight.js');
 
 var lex = require('./lex');
 var renderer = require('./renderer');
 
+var codeInclude = require('./code_include');
 var lnormalize = require('../utils/lang').normalize;
 
 
@@ -12,13 +13,12 @@ var lnormalize = require('../utils/lang').normalize;
 // Render a section using our custom renderer
 function render(section, _options) {
     // Copy section
+    var links = section.links || {};
     section = _.toArray(section);
-
-    // marked's Render expects this, we don't use it yet
-    section.links = {};
+    section.links = links;
 
     // Build options using defaults and our custom renderer
-    var options = _.extend({}, marked.defaults, {
+    var options = _.extend({}, kramed.defaults, {
         renderer: renderer(null, _options),
 
         // Synchronous highlighting with highlight.js
@@ -36,7 +36,7 @@ function render(section, _options) {
         }
     });
 
-    return marked.parser(section, options);
+    return kramed.parser(section, options);
 }
 
 function quizQuestion(node) {
@@ -74,15 +74,20 @@ function parsePage(src, options) {
             // Main language
             var lang = validLangs ? langs[0] : null;
 
+            // codeInclude shortcut
+            var ci = function(code) {
+                return codeInclude(code, options.dir);
+            };
+
             return {
                 id: section.id,
                 type: section.type,
                 content: render(nonCodeNodes),
                 lang: lang,
                 code: {
-                    base: codeNodes[0].text,
-                    solution: codeNodes[1].text,
-                    validation: codeNodes[2].text,
+                    base: ci(codeNodes[0].text),
+                    solution: ci(codeNodes[1].text),
+                    validation: ci(codeNodes[2].text),
                     // Context is optional
                     context: codeNodes[3] ? codeNodes[3].text : null,
                 }

lib/parse/progress.js

@@ -11,9 +11,6 @@ var calculProgress = function(navigation, current) {
         nav.path = path;
         return nav;
     })
-    .sortBy(function(nav) {
-        return parseFloat(nav.level);
-    })
     .map(function(nav, i) {
         // Calcul percent
         nav.percent = (i * 100) / Math.max((n - 1), 1);

lib/parse/readme.js

@@ -1,5 +1,5 @@
 var _ = require('lodash');
-var marked = require('marked');
+var kramed = require('kramed');
 var textRenderer = require('marked-text-renderer');
 
 function extractFirstNode(nodes, nType) {
@@ -18,7 +18,7 @@ function parseReadme(src) {
     var renderer = textRenderer();
 
     // Parse content
-    nodes = marked.lexer(src);
+    nodes = kramed.lexer(src);
 
     title = extractFirstNode(nodes, "heading") || '';
     description = extractFirstNode(nodes, "paragraph") || '';
@@ -28,7 +28,7 @@ function parseReadme(src) {
             return _.unescape(text.replace(/(\r\n|\n|\r)/gm, ""));
         },
         function(text) {
-            return marked.parse(text, _.extend({}, marked.defaults, {
+            return kramed.parse(text, _.extend({}, kramed.defaults, {
                 renderer: renderer
             }));
         }

lib/parse/renderer.js

@@ -1,11 +1,12 @@
 var url = require('url');
 var inherits = require('util').inherits;
 var links = require('../utils').links;
+var codeInclude = require('./code_include');
 
 
 var path = require('path');
 
-var marked = require('marked');
+var kramed = require('kramed');
 
 var rendererId = 0;
 
@@ -20,7 +21,7 @@ function GitBookRenderer(options, extra_options) {
     this.id = rendererId++;
     this.quizIndex = 0;
 }
-inherits(GitBookRenderer, marked.Renderer);
+inherits(GitBookRenderer, kramed.Renderer);
 
 GitBookRenderer.prototype._unsanitized = function(href) {
     var prot = '';
@@ -56,7 +57,7 @@ GitBookRenderer.prototype.link = function(href, title, text) {
 
     // Relative link, rewrite it to point to github repo
     if(links.isRelative(_href)) {
-        if (path.extname(_href) == ".md") {
+        if (path.extname(parsed.path) == ".md") {
             _href = links.toAbsolute(_href, o.dir || "./", o.outdir || "./");
 
             if (o.singleFile) {
@@ -125,7 +126,7 @@ GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
     var length = splittedText.length;
     var label = '<label class="quiz-label" for="' + quizIdentifier + '">' + splittedText[length - 1] + '</label>';
     return text.replace(fieldRegex, field).replace(splittedText[length - 1], label);
-}
+};
 
 GitBookRenderer.prototype.tablecell = function(content, flags) {
     return GitBookRenderer.super_.prototype.tablecell(this._createCheckboxAndRadios(content), flags);
@@ -135,5 +136,20 @@ GitBookRenderer.prototype.listitem = function(text) {
     return GitBookRenderer.super_.prototype.listitem(this._createCheckboxAndRadios(text));
 };
 
+GitBookRenderer.prototype.code = function(code, lang, escaped) {
+    return GitBookRenderer.super_.prototype.code.call(
+        this,
+        // Import code snippets
+        codeInclude(code, this._extra_options.dir),
+        lang,
+        escaped
+    );
+};
+
+GitBookRenderer.prototype.heading = function(text, level, raw) {
+    var id = this.options.headerPrefix + raw.toLowerCase().replace(/[^\w -]+/g, '').replace(/ /g, '-');
+    return '<h' + level + ' id="' + id + '">' + text + '</h' + level + '>\n';
+};
+
 // Exports
 module.exports = GitBookRenderer;

lib/parse/summary.js

@@ -1,5 +1,5 @@
 var _ = require('lodash');
-var marked = require('marked');
+var kramed = require('kramed');
 
 
 // Utility function for splitting a list into groups
@@ -43,7 +43,7 @@ function listSplit(nodes, start_type, end_type) {
 }
 
 // Get the biggest list
-// out of a list of marked nodes
+// out of a list of kramed nodes
 function filterList(nodes) {
     return _.chain(nodes)
     .toArray()
@@ -64,7 +64,7 @@ function filterList(nodes) {
 // supports extracting links
 function parseTitle(src, nums) {
     // Check if it's a link
-    var matches = marked.InlineLexer.rules.link.exec(src);
+    var matches = kramed.InlineLexer.rules.link.exec(src);
 
     var level = nums.join('.');
 
@@ -81,12 +81,17 @@ function parseTitle(src, nums) {
         title: matches[1],
         level: level,
 
-        // Replace .md references with .html
-        path: matches[2].replace(/\\/g, '/'),
+        // Normalize path
+        // 1. Convert Window's "\" to "/"
+        // 2. Remove leading "/" if exists
+        path: matches[2].replace(/\\/g, '/').replace(/^\/+/, ''),
     };
 }
 
 function parseChapter(nodes, nums) {
+    // Convert single number to an array
+    nums = _.isArray(nums) ? nums : [nums];
+
     return _.extend(parseTitle(_.first(nodes).text, nums), {
         articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), function(nodes, i) {
             return parseChapter(nodes, nums.concat(i + 1));
@@ -94,24 +99,50 @@ function parseChapter(nodes, nums) {
     });
 }
 
+function defaultChapterList(chapterList) {
+    var first = _.first(chapterList);
+
+    // Check if introduction node was specified in SUMMARY.md
+    if (first) {
+        var chapter = parseChapter(first, [0]);
+
+        // Already have README node, we're good to go
+        if(chapter.path === 'README.md') {
+            return chapterList;
+        }
+    }
+
+    // It wasn't specified, so add in default
+    return [
+        [ { type: 'text', text: '[Introduction](README.md)' } ]
+    ].concat(chapterList);
+}
+
+function listGroups(src) {
+    var nodes = kramed.lexer(src);
+
+    // Get out groups of lists
+    return listSplit(
+        filterList(nodes),
+        'list_item_start', 'list_item_end'
+    );
+}
+
 function parseSummary(src) {
-    var nodes = marked.lexer(src);
-
-    // Get out list of chapters
-    var chapterList = filterList(nodes);
-
     // Split out chapter sections
-    var chapters = _.chain(listSplit(chapterList, 'list_item_start', 'list_item_end'))
-    .map(function(nodes, i) {
-        return parseChapter(nodes, [i + 1]);
-    })
-    .value();
+    var chapters = defaultChapterList(listGroups(src))
+    .map(parseChapter);
 
     return {
         chapters: chapters
     };
 }
 
+function parseEntries (src) {
+    return listGroups(src).map(parseChapter);
+}
+
 
 // Exports
 module.exports = parseSummary;
+module.exports.entries = parseEntries;

lib/utils/lang.js

@@ -2,6 +2,7 @@ var MAP = {
     'py': 'python',
     'js': 'javascript',
     'rb': 'ruby',
+    'csharp': 'cs',
 };
 
 function normalize(lang) {

lib/utils/links.js

@@ -1,11 +1,24 @@
 var url = require('url');
 var path = require('path');
 
+// Is the link an external link
+var isExternal = function(href) {
+    try {
+        return Boolean(url.parse(href).protocol);
+    } catch(err) { }
+
+    return false;
+};
+
 // Return true if the link is relative
 var isRelative = function(href) {
-    var parsed = url.parse(href);
+    try {
+        var parsed = url.parse(href);
 
-    return !parsed.protocol && parsed.path && parsed.path[0] != '/';
+        return !parsed.protocol && parsed.path && parsed.path[0] != '/';
+    } catch(err) {}
+
+    return true;
 };
 
 // Relative to absolute path
@@ -26,8 +39,22 @@ var toAbsolute = function(_href, dir, outdir) {
     return _href;
 };
 
+// Join links
+
+var join = function() {
+    var _href = path.join.apply(path, arguments);
+
+    if (process.platform === 'win32') {
+        _href = _href.replace(/\\/g, '/');
+    }
+
+    return _href;
+};
+
 
 module.exports = {
     isRelative: isRelative,
-    toAbsolute: toAbsolute
-};
+    isExternal: isExternal,
+    toAbsolute: toAbsolute,
+    join: join
+};

lib/utils/string.js

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

package.json

@@ -1,19 +1,20 @@
 {
     "name": "gitbook",
-    "version": "0.4.8",
+    "version": "0.7.0",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
     "dependencies": {
         "q": "1.0.1",
         "lodash": "2.4.1",
-        "marked": "0.3.2",
-        "marked-text-renderer": "0.0.1",
+        "kramed": "0.4.0",
+        "marked-text-renderer": "0.1.0",
         "lunr": "0.5.2",
         "swig": "1.3.2",
         "send": "0.2.0",
         "fstream-ignore": "0.0.7",
         "commander": "2.2.0",
+        "graceful-fs": "3.0.2",
         "fs-extra": "0.8.1",
         "highlight.js": "8.0.0",
         "tmp": "0.0.23",
@@ -22,8 +23,7 @@
         "resolve": "0.6.3",
         "tiny-lr-fork": "0.0.5",
         "gitbook-plugin": "0.0.2",
-        "gitbook-plugin-mixpanel": "0.0.2",
-        "gitbook-plugin-mathjax": "0.0.3",
+        "gitbook-plugin-mathjax": "0.0.4",
         "gitbook-plugin-livereload": "0.0.1"
     },
     "devDependencies": {

test/fixtures/ALTERNATIVE_SUMMARY.md

@@ -0,0 +1,13 @@
+# Summary
+
+* [Custom name for Introduction](README.md)
+* [Chapter 1](chapter-1/README.md)
+    * [Article 1](chapter-1/ARTICLE1.md)
+    * [Article 2](chapter-1/ARTICLE2.md)
+        * [article 1.2.1](chapter-1/ARTICLE-1-2-1.md)
+        * [article 1.2.2](chapter-1/ARTICLE-1-2-2.md)
+* [Chapter 2](chapter-2/README.md)
+* [Chapter 3](chapter-3/README.md)
+* [Chapter 4](chapter-4/README.md)
+    * Unfinished article
+* Unfinished Chapter

test/fixtures/INCLUDES.md

@@ -0,0 +1,29 @@
+# Beautiful chapter
+
+Here is a nice included snippet :
+
+```c
+{{ included.c }}
+```
+
+----
+
+An exercise using includes
+
+```c
+{{ included.c }}
+
+Remove this extra code at the end
+```
+
+```c
+{{ included.c }}
+```
+
+```c
+{{ included.c }}
+
+This validation code is wrong but who cares ?
+```
+
+----

test/fixtures/SUMMARY.md

@@ -3,8 +3,8 @@
 * [Chapter 1](chapter-1/README.md)
     * [Article 1](chapter-1/ARTICLE1.md)
     * [Article 2](chapter-1/ARTICLE2.md)
-        * [article 1.2.1](chapter-1/ARTICLE-1-2-1.md)
-        * [article 1.2.2](chapter-1/ARTICLE-1-2-2.md)
+        * [article 1.2.1](\chapter-1\ARTICLE-1-2-1.md)
+        * [article 1.2.2](/chapter-1/ARTICLE-1-2-2.md)
 * [Chapter 2](chapter-2/README.md)
 * [Chapter 3](chapter-3/README.md)
 * [Chapter 4](chapter-4/README.md)

test/fixtures/included.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+int main(int argc, char *argv[]) {
+    printf("All is well\n");
+
+    return 0;
+}

test/includes.js

@@ -0,0 +1,38 @@
+var fs = require('fs');
+var path = require('path');
+var assert = require('assert');
+
+var page = require('../').parse.page;
+
+var FIXTURES_DIR = path.join(__dirname, './fixtures/');
+
+function loadPage (name, options) {
+    var CONTENT = fs.readFileSync(FIXTURES_DIR + name + '.md', 'utf8');
+    return page(CONTENT, options);
+}
+
+
+describe('Code includes', function() {
+
+    var LEXED = loadPage('INCLUDES', {
+        'dir': FIXTURES_DIR,
+    });
+
+    var INCLUDED_C = fs.readFileSync(path.join(FIXTURES_DIR, 'included.c'), 'utf8');
+
+    it('should work for snippets', function() {
+        assert.equal(LEXED[0].type, 'normal');
+        // Has replaced include
+        assert.equal(
+            LEXED[0].content.indexOf('{{ included.c }}'),
+            -1
+        );
+    });
+
+    it('should work for exercises', function() {
+        assert.equal(LEXED[1].type, 'exercise');
+
+        // Solution is trimmed version of source
+        assert.equal(LEXED[1].code.solution, INCLUDED_C.trim());
+    });
+});

test/navigation.js

@@ -7,7 +7,9 @@ var navigation = require('../').parse.navigation;
 
 
 var CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/SUMMARY.md'), 'utf8');
+var ALT_CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/ALTERNATIVE_SUMMARY.md'), 'utf8');
 var LEXED = summary(CONTENT);
+var ALT_LEXED = summary(ALT_CONTENT);
 
 
 describe('Summary navigation', function() {
@@ -76,6 +78,21 @@ describe('Summary navigation', function() {
         assert.equal(nav['chapter-3/README.md'].level, '3');
     });
 
+    it('should have a default README node', function() {
+        var nav = navigation(LEXED);
+
+        assert.equal(nav['README.md'].level, '0');
+        assert.equal(nav['README.md'].title, 'Introduction');
+    });
+
+    it('Should allow README node to be customized', function() {
+        var nav = navigation(ALT_LEXED);
+
+        assert(nav['README.md']);
+        assert.equal(nav['README.md'].level, '0');
+        assert.notEqual(nav['README.md'].title, 'Introduction');
+    });
+
     it('should not accept null paths', function() {
         var nav = navigation(LEXED);
 

test/summary.js

@@ -12,13 +12,13 @@ var LEXED = summary(CONTENT);
 describe('Summary parsing', function () {
 
     it('should detect chapters', function() {
-        assert.equal(LEXED.chapters.length, 5);
+        assert.equal(LEXED.chapters.length, 6);
     });
 
     it('should support articles', function() {
-        assert.equal(LEXED.chapters[0].articles.length, 2);
-        assert.equal(LEXED.chapters[1].articles.length, 0);
+        assert.equal(LEXED.chapters[1].articles.length, 2);
         assert.equal(LEXED.chapters[2].articles.length, 0);
+        assert.equal(LEXED.chapters[3].articles.length, 0);
     });
 
     it('should detect paths and titles', function() {
@@ -26,30 +26,34 @@ describe('Summary parsing', function () {
         assert(LEXED.chapters[1].path);
         assert(LEXED.chapters[2].path);
         assert(LEXED.chapters[3].path);
-        assert.equal(LEXED.chapters[4].path, null);
+        assert(LEXED.chapters[4].path);
+        assert.equal(LEXED.chapters[5].path, null);
 
         assert(LEXED.chapters[0].title);
         assert(LEXED.chapters[1].title);
         assert(LEXED.chapters[2].title);
         assert(LEXED.chapters[3].title);
         assert(LEXED.chapters[4].title);
+        assert(LEXED.chapters[5].title);
     });
 
     it('should normalize paths from .md to .html', function() {
-        assert.equal(LEXED.chapters[0].path,'chapter-1/README.md');
-        assert.equal(LEXED.chapters[1].path,'chapter-2/README.md');
-        assert.equal(LEXED.chapters[2].path,'chapter-3/README.md');
+        assert.equal(LEXED.chapters[0].path,'README.md');
+        assert.equal(LEXED.chapters[1].path,'chapter-1/README.md');
+        assert.equal(LEXED.chapters[2].path,'chapter-2/README.md');
+        assert.equal(LEXED.chapters[3].path,'chapter-3/README.md');
     });
 
     it('should detect levels correctly', function() {
         var c = LEXED.chapters;
 
-        assert.equal(c[0].level, '1');
-        assert.equal(c[1].level, '2');
-        assert.equal(c[2].level, '3');
+        assert.equal(c[0].level, '0');
+        assert.equal(c[1].level, '1');
+        assert.equal(c[2].level, '2');
+        assert.equal(c[3].level, '3');
 
-        assert.equal(c[0].articles[0].level, '1.1');
-        assert.equal(c[0].articles[1].level, '1.2');
-        assert.equal(c[0].articles[1].articles[0].level, '1.2.1');
+        assert.equal(c[1].articles[0].level, '1.1');
+        assert.equal(c[1].articles[1].level, '1.2');
+        assert.equal(c[1].articles[1].articles[0].level, '1.2.1');
     });
 });

theme/javascript/core/exercise.js

@@ -1,9 +1,13 @@
 define([
     "jQuery",
+    "ace/ace",
+    "ace/theme-tomorrow",
+    "ace/mode-javascript",
     "utils/execute",
     "core/events",
     "core/state"
-], function($, execute, events, state){
+], function($, _ace, _aceTheme, _aceMode, execute, events, state){
+
     // Bind an exercise
     var prepareExercise = function($exercise) {
         var codeSolution = $exercise.find(".code-solution").text();
@@ -14,6 +18,14 @@ define([
         editor.setTheme("ace/theme/tomorrow");
         editor.getSession().setUseWorker(false);
         editor.getSession().setMode("ace/mode/javascript");
+        
+        editor.commands.addCommand({
+            name: "submit",
+            bindKey: "Ctrl-Return|Cmd-Return",
+            exec: function() {
+                $exercise.find(".action-submit").click();
+            }
+        });
 
         // Submit: test code
         $exercise.find(".action-submit").click(function(e) {
@@ -48,4 +60,4 @@ define([
         init: init,
         prepare: prepareExercise
     };
-});
+});

theme/javascript/core/font-settings.js

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

theme/javascript/core/navigation.js

@@ -9,7 +9,6 @@ define([
     "core/loading"
 ], function($, URL, events, state, progress, exercises, quiz, loading) {
     var prev, next;
-    var githubCountStars, githubCountWatch;
 
     var usePushState = (typeof history.pushState !== "undefined");
 
@@ -63,11 +62,6 @@ define([
         }));
     };
 
-    var updateGitHubCounts = function() {
-        $(".book-header .count-star span").text(githubCountStars);
-        $(".book-header .count-watch span").text(githubCountWatch);
-    };
-
     var updateNavigationPosition = function() {
         var bodyInnerWidth, pageWrapperWidth;
 
@@ -95,20 +89,6 @@ define([
         // Focus on content
         $pageWrapper.focus();
 
-        // Update GitHub count
-        if (state.githubId) {
-            if (githubCountStars) {
-                updateGitHubCounts();
-            } else {
-                $.getJSON("https://api.github.com/repos/"+state.githubId)
-                .done(function(repo) {
-                    githubCountStars = repo.stargazers_count;
-                    githubCountWatch = repo.subscribers_count;
-                    updateGitHubCounts();
-                });
-            }
-        }
-
         // Send to mixpanel
         events.trigger("page.change");
     };

theme/javascript/utils/sharing.js

@@ -13,6 +13,9 @@ define([
         },
         "google-plus": function($el) {
             window.open("https://plus.google.com/share?url="+encodeURIComponent(url))
+        },
+        "weibo": function($el) {
+            window.open("http://service.weibo.com/share/share.php?content=utf-8&url="+encodeURIComponent(url)+"&title="+encodeURIComponent(title))
         }
     };
 
@@ -30,4 +33,4 @@ define([
     return {
         init: init
     };
-});
+});

theme/stylesheets/ebook.less

@@ -0,0 +1,40 @@
+@import "mixins.less";
+
+@import "ebook/variables.less";
+@import "ebook/highlight.less";
+
+.book-chapter {
+    display: none;
+}
+
+
+pre, blockquote {
+    border: 1px solid #999;
+    page-break-inside: avoid;
+    background: #f1f1f1;
+    padding: 8px;
+}
+
+img {
+    max-width: 100% !important;
+    page-break-inside: avoid;
+    margin: 0px auto;
+}
+
+.exercise, .quiz {
+    margin: 1cm 0cm;
+    padding: 0.4cm;
+    page-break-inside: avoid;
+
+    border: 3px solid #ddd;
+
+    .exercise-header {
+        margin-bottom: 0.4cm;
+        padding-bottom: 0.2cm;
+        border-bottom: 1px solid #ddd;
+    }
+
+    .question {
+        margin-top: 0.4cm;
+    }
+}

theme/stylesheets/ebook/variables.less

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

theme/stylesheets/mixins.less

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

theme/stylesheets/print.less

@@ -1,48 +0,0 @@
-@import "vendors/bootstrap/bootstrap.less";
-
-@import "mixins.less";
-/*@import "variables.less";*/
-
-@import "page/highlight.less";
-
-
-@font-size-base:          13px;
-
-.book-chapter {
-    display: none;
-}
-
-article {
-    page-break-after: always;
-}
-
-h1 { font-size: floor(@font-size-base * 2.15); }
-h2 { font-size: floor(@font-size-base * 1.70); }
-h3 { font-size: ceil(@font-size-base * 1.25); }
-h4 { font-size: ceil(@font-size-base * 1); }
-h5 { font-size:  ceil(@font-size-base * 0.85); }
-h6 { font-size: ceil(@font-size-base * 0.65); }
-
-pre, blockquote {
-    border: 1px solid #999;
-    page-break-inside: avoid;
-}
-
-img {
-    max-width: 100% !important;
-    page-break-inside: avoid;
-}
-
-.exercise {
-    margin: 1cm 0cm;
-    padding: 0.4cm;
-    page-break-inside: avoid;
-
-    border: 3px solid #ddd;
-
-    .exercise-header {
-        margin-bottom: 0.4cm;
-        padding-bottom: 0.2cm;
-        border-bottom: 1px solid #ddd;
-    }
-}

theme/stylesheets/website.less

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

theme/stylesheets/website/body.less

@@ -37,7 +37,8 @@
 
                     background: @page-background;
                     border-radius: 2px;
-                    line-height: 1.5em;
+                    line-height: @content-line-height;
+                    font-size: @default-font-size;
                 }
 
                 .btn-group {
@@ -102,27 +103,27 @@
     }
 
     &.font-size-0 {
-        .book-body {
+        .book-body .page-inner section {
             font-size:@s-font-size;
         }
     }
     &.font-size-1 {
-        .book-body {
+        .book-body .page-inner section {
             font-size:@m-font-size;
         }
     }
     &.font-size-2 {
-        .book-body {
+        .book-body .page-inner section {
             font-size:@l-font-size;
         }
     }
-    &.font-size-3 {
-        .book-body {
+    &.font-size-3{
+        .book-body .page-inner section {
             font-size:@xl-font-size;
         }
     }
     &.font-size-4 {
-        .book-body {
+        .book-body .page-inner section {
             font-size:@xxl-font-size;
         }
     }

theme/stylesheets/website/fonts.less

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

theme/stylesheets/website/header.less

@@ -13,7 +13,7 @@
         font-size: 0.85em;
         color: @header-color;
         background: @header-background;
-        box-shadow: 0 1px 2px hsla(200,10%,80%,0.6);
+        border-bottom: 1px solid @header-border;
 
         .btn {
             display: block;
@@ -44,12 +44,16 @@
             padding-right: 200px;
             .transition(margin-left 0.5s ease);
 
+            overflow: hidden;
+            text-overflow: ellipsis;
+            white-space: nowrap;
+
             a, a:hover {
                 color: inherit;
                 text-decoration: none;
             }
 
-            @media (max-width: 800px) {
+            @media (max-width: 1000px) {
                 display: none;
             }
 

theme/stylesheets/website/navigation.less

@@ -13,7 +13,7 @@
         flex-direction: column;
 
         font-size: 40px;
-        color: rgba(0,0,0,0.4);
+        color: rgba(0, 0, 0, 0.2);
 
         text-align: center;
 
@@ -21,7 +21,7 @@
 
         &:hover {
             text-decoration: none;
-            color: rgba(0,0,0,0.6);
+            color: rgba(0, 0, 0, 0.6);
         }
 
         &.navigation-next {
@@ -49,10 +49,14 @@
     }
 }
 .book.color-theme-1 .book-body  {
-    .navigation:hover{
-    }
+
 }
 .book.color-theme-2 .book-body  {
-    .navigation:hover{
+    .navigation {
+        color: rgba(255, 255, 255, 0.4);
+
+        &:hover {
+            color: rgba(255, 255, 255, 0.9);
+        }
     }
 }

theme/stylesheets/website/summary.less

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

theme/stylesheets/website/variables.less

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

theme/templates/includes/book/header.html

@@ -21,10 +21,8 @@
     {% if options.links.sharing.twitter !== false %}
     <a href="#" target="_blank" class="btn pull-right twitter-sharing-link sharing-link" data-sharing="twitter" aria-label="Share on Twitter"><i class="fa fa-twitter"></i></a>
     {% endif %}
-
-    {% if githubId %}
-    <a href="{{ githubHost }}{{ githubId }}/stargazers" target="_blank" class="btn pull-right count-star hidden-xs"><i class="fa fa-star-o"></i> Star (<span>-</span>)</a>
-    <a href="{{ githubHost }}{{ githubId }}/watchers" target="_blank" class="btn pull-right count-watch hidden-xs"><i class="fa fa-eye"></i> Watch (<span>-</span>)</a>
+    {% if options.links.sharing.weibo === true %}
+    <a href="#" target="_blank" class="btn pull-right twitter-sharing-link sharing-link" data-sharing="weibo" aria-label="Share on Weibo"><i class="fa fa-weibo"></i></a>
     {% endif %}
 
     <!-- Title -->

theme/templates/includes/book/summary.html

@@ -1,10 +1,25 @@
 {% macro articles(_articles) %}
     {% for item in _articles %}
-        <li class="chapter {% if item._path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path %}data-path="{{ item.path|mdLink }}"{% endif %}>
+        {% set externalLink = item.path|isExternalLink %}
+        <li class="chapter {% if item.path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path && !externalLink %}data-path="{{ item.path|mdLink }}"{% endif %}>
             {% if item.path %}
-            <a href="{{ basePath }}/{{ item.path|mdLink }}">
-                <i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
-            </a>
+                {% if !externalLink %}
+                    <a href="{{ basePath }}/{{ item.path|mdLink }}">
+                        <i class="fa fa-check"></i>
+                        {% if item.level !== "0" %}
+                            <b>{{ item.level }}.</b>
+                        {% endif %}
+                         {{ item.title }}
+                    </a>
+                {% else %}
+                    <a target="_blank" href="{{ item.path }}">
+                        <i class="fa fa-check"></i>
+                        {% if item.level !== "0" %}
+                            <b>{{ item.level }}.</b>
+                        {% endif %}
+                         {{ item.title }}
+                    </a>
+                {% endif %}
             {% else %}
             <span><b>{{ item.level }}.</b> {{ item.title }}</span>
             {% endif %}
@@ -33,7 +48,7 @@
         {% if options.links.issues !== false && (options.links.issues || githubId) %}
         {% set _divider = true %}
         <li>
-            <a href="{{ options.links.issues|default(githubHost+githubId+"/issues") }}" target="blank"class="issues-link">Questions and Issues</a>
+            <a href="{{ options.links.issues|default(githubHost+githubId+"/issues") }}" target="blank" class="issues-link">Questions and Issues</a>
         </li>
         {% endif %}
 
@@ -44,13 +59,19 @@
         </li>
         {% endif %}
 
+	{% if options.links.custom %}
+	{% for link in options.links.custom %}
+	    {% set _divider = true %}
+	     <li> 
+	         <a href="{{ options.links.custom[loop.key] }}" target="blank" class="custom-link">{{ loop.key }}</a>
+             </li>
+	{% endfor %}
+	{% endif %}
+
         {% if _divider %}
         <li class="divider"></li>
         {% endif %}
 
-        <li data-level="0" data-path="index.html">
-            <a href="{{ basePath }}/"><i class="fa fa-check"></i> Introduction</a>
-        </li>
         {{ articles(summary.chapters) }}
 
         {% if options.links.gitbook !== false %}

theme/templates/langs.html

@@ -2,6 +2,10 @@
 
 {% block title %}{{ title }}{% endblock %}
 
+{% block style %}
+<link rel="stylesheet" href="{{ staticBase }}/style.css">
+{% endblock %}
+
 {% block content %}
 <div class="book-langs-index">
     <div class="inner">
@@ -10,7 +14,7 @@
         <ul class="languages">
         {%  for lang in langs %}
             <li>
-                <a href="{{ basePath}}/{{ lang.path }}">{{ lang.title }}</a>
+                <a href="{{ basePath}}/{{ lang.path|pathJoin("/index.html") }}">{{ lang.title }}</a>
             </li>
         {% endfor %}
         </ul>

theme/templates/layout.html

@@ -1,54 +1,26 @@
 <!DOCTYPE HTML>
 <html lang="en-US" {% block htmlTag %}{% endblock %}>
     {{ htmlSnippet("html:start")|default("") }}
-    <head prefix="og: http://ogp.me/ns# book: http://ogp.me/ns/book#">
+    <head>
         {{ htmlSnippet("head:start")|default("") }}
-        {% block head %}
         <meta charset="UTF-8">
-        <title>{% block title %} | {{ title }}{% endblock %}</title>
-
+        <title>{% block title %}{% endblock %}</title>
         <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
-        <meta name="robots" content="index, follow">
-        <meta name="author" content="{{ githubAuthor }}">
-        <meta name="description" content="{{ description }}">
-        <meta name="keywords" content="gitbook,github" >
-        <meta name="generator" content="www.gitbook.io">
-
-        {% if progress.current.next and progress.current.next.path %}
-        <link rel="next" href="{{ basePath }}/{{ progress.current.next.path|mdLink }}" />
-        {% endif %}
-        {% if progress.current.prev and progress.current.prev.path %}
-        <link rel="prev" href="{{ basePath }}/{{ progress.current.prev.path|mdLink }}" />
-        {% endif %}
-
-        <meta property="og:title" content="{% block title %} | {{ title }}{% endblock %}">
-        <meta property="og:site_name" content="{{ title }}">
-        <meta property="og:type" content="book">
-        <meta property="og:locale" content="en_US">
-
-        <meta property="book:author" content="{{ githubHost }}{{ githubAuthor }}">
-        <meta property="book:tag" content="GitBook">
-
+        <meta name="description" content="{% block description %}{% endblock %}">
+        <meta name="generator" content="GitBook {{ gitbook.version }}">
+        <meta name="HandheldFriendly" content="true"/>
         <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
         <meta name="apple-mobile-web-app-capable" content="yes">
         <meta name="apple-mobile-web-app-status-bar-style" content="black">
-
         <link rel="shortcut icon" href="{{ staticBase }}/images/favicon.ico" type="image/x-icon">
-        {% endblock %}
+        {% block head %}{% endblock %}
         {{ htmlSnippet("head:end")|default("") }}
     </head>
     <body>
         {{ htmlSnippet("body:start")|default("") }}
-        {% block style %}
-        <link rel="stylesheet" href="{{ staticBase }}/style.css">
-        {% endblock %}
+        {% block style %}{% endblock %}
         {% block content %}{% endblock %}
-        {% block javascript %}
-        <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/ace.js"></script>
-        <script src="https://cdnjs.cloudflare.com/ajax/libs/ace/1.1.3/mode-javascript.js"></script>
-        <script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script>
-        <script src="{{ staticBase }}/app.js"></script>
-        {% endblock %}
+        {% block javascript %}{% endblock %}
         {{ htmlSnippet("body:end")|default("") }}
     </body>
     {{ htmlSnippet("html:end")|default("") }}

theme/templates/page.html

@@ -20,9 +20,14 @@
             </div>
         {% elif section.type == "quiz" %}
         <div class="quiz">
-            <div class="exercise-header">Exercise #{{ exercise }}</div>
+            <div class="exercise-header">Quiz #{{ exercise }}</div>
             {% autoescape false %}{{ section.content }}{% endautoescape %}
-            {% autoescape false %}{{ section.quiz.base }}{% endautoescape %}
+            {% for quiz in section.quiz %}
+                <div class="question">
+                    <div class="question-header">Question {{ loop.index }} of {{ section.quiz.length }}</div>
+                    {% autoescape false %}{{ quiz.base }}{% endautoescape %}
+                </div>
+            {% endfor %}
             {% set exercise = exercise + 1 %}
         </div>
         {% endif %}
@@ -47,6 +52,7 @@
         {% set exercise = 1 %}
         <article>
             <h1 class="book-chapter book-chapter-1">Exercise Solutions</h1>
+            <h1>Exercise Solutions</h1>
 
             {% for item in progress.chapters %}
                 {% if pages[item.path] %}
@@ -60,9 +66,14 @@
                             </div>
                         {% elif section.type == "quiz" %}
                             <div class="quiz">
-                                <div class="exercise-header">Exercise #{{ exercise }}</div>
+                                <div class="exercise-header">Quiz #{{ exercise }}</div>
                                 {% autoescape false %}{{ section.content }}{% endautoescape %}
-                                {% autoescape false %}{{ section.quiz.solution }}{% endautoescape %}
+                                {% for quiz in section.quiz %}
+                                    <div class="question">
+                                        <div class="question-header">Question {{ loop.index }} of {{ section.quiz.length }}</div>
+                                        {% autoescape false %}{{ quiz.solution }}{% endautoescape %}
+                                    </div>
+                                {% endfor %}
                                 {% set exercise = exercise + 1 %}
                             </div>
                         {% endif %}

theme/templates/site.html

@@ -1,7 +1,23 @@
 {% extends "layout.html" %}
 
 {% block htmlTag %}{% if options.cache !== false %}manifest="{{ basePath }}/manifest.appcache"{% endif %}{% endblock %}
-{% block title %}{{ progress.current.title }}{% parent %}{% endblock %}
+
+{% block head %}
+    {% parent %}
+    {% if githubAuthor %}
+    <meta name="author" content="{{ githubAuthor }}">
+    {% endif %}
+    {% if progress.current.next and progress.current.next.path %}
+    <link rel="next" href="{{ basePath }}/{{ progress.current.next.path|mdLink }}" />
+    {% endif %}
+    {% if progress.current.prev and progress.current.prev.path %}
+    <link rel="prev" href="{{ basePath }}/{{ progress.current.prev.path|mdLink }}" />
+    {% endif %}
+{% endblock %}
+
+{% block title %}{{ progress.current.title }} | {{ title }}{% endblock %}
+{% block description %}{% if progress.current.level == "0" %}{{ description }}{% endif %}{% endblock %}
+
 {% block content %}
     <div class="book" {% if githubId %}data-github="{{ githubId }}"{% endif %} data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">
     {% include "includes/book/header.html" %}
@@ -38,7 +54,8 @@
 {% endblock %}
 
 {% block javascript %}
-{% parent %}
+<script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script>
+<script src="{{ staticBase }}/app.js"></script>
 {% for resource in plugins.resources.js %}
     {% if resource.url %}
     <script src="{{ resource.url }}"></script>
@@ -55,7 +72,7 @@ require(["gitbook"], function(gitbook) {
 {% endblock %}
 
 {% block style %}
-{% parent %}
+<link rel="stylesheet" href="{{ staticBase }}/style.css">
 {% for resource in plugins.resources.css %}
     {% if resource.url %}
     <link rel="stylesheet" href="{{ resource.url }}">