Bump version to 0.4.6

Serve command disable cache

.gitignore

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

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.
+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. A complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
 
 ![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
 
@@ -110,7 +110,7 @@ A book is a Git repository containing at least 2 files: `README.md` and `SUMMARY
 
 #### README.md
 
-As usual, it should contains an introduction for your book. It will be automatically added to the final summary.
+Typically, this should be the introduction for your book. It will be automatically added to the final summary.
 
 #### SUMMARY.md
 
@@ -130,7 +130,7 @@ This is the summary of my book.
     * [example 1](section2/example1.md)
 ```
 
-Files that are not included in the `SUMMARY.md` will not be processed by `gitbook`.
+Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
 
 #### Exercises
 

bin/gitbook.js

@@ -4,6 +4,7 @@ var Q = require('q');
 var _ = require('lodash');
 var path = require('path');
 var prog = require('commander');
+var tinylr = require('tiny-lr-fork');
 
 var pkg = require('../package.json');
 var generators = require("../lib/generate").generators;
@@ -29,12 +30,24 @@ build.command(prog.command('serve [source_dir]'))
 .action(function(dir, options) {
     var server = new Server();
 
+    // init livereload server
+    var lrOptions = {port: 35729};
+    var lrServer = tinylr(lrOptions);
+    var lrPath = undefined;
+    lrServer.listen(lrOptions.port, function(err) {
+      if (err) { return console.log(err); }
+      console.log('Live reload server started on port: ' + lrOptions.port);
+    });
+
     var generate = function() {
         if (server.isRunning()) console.log("Stopping server");
 
         server.stop()
         .then(function() {
-            return build.folder(dir, options);
+            return build.folder(dir, _.extend(options || {}, {
+                cache: false,
+                defaultsPlugins: ["livereload"]
+            }));
         })
         .then(function(_options) {
             console.log();
@@ -43,9 +56,16 @@ build.command(prog.command('serve [source_dir]'))
             .then(function() {
                 console.log('Serving book on http://localhost:'+options.port);
 
+                if (lrPath) {
+                  // trigger livereload
+                  lrServer.changed({body:{files:[lrPath]}})
+                }
+
                 if (!options.watch) return;
                 return utils.watch(_options.input)
                 .then(function(filepath) {
+                    // set livereload path
+                    lrPath = filepath;
                     console.log("Restart after change in files");
                     console.log('');
                     return generate();

lib/generate/generator.js

@@ -9,6 +9,7 @@ var BaseGenerator = function(options) {
     this.options = options;
 
     this.options.plugins = Plugin.normalizeNames(this.options.plugins);
+    this.options.plugins = _.union(this.options.plugins, this.options.defaultsPlugins);
     this.plugins = [];
 };
 

lib/generate/index.js

@@ -64,6 +64,7 @@ var generate = function(options) {
         // Plugins
         "plugins": [],
         "pluginsConfig": {},
+        "defaultsPlugins": [], // Default plugins that can't be set in book.json
 
         // Links
         "links": {
@@ -86,6 +87,21 @@ var generate = function(options) {
     // Check files to get folder type (book, multilanguage book or neither)
     return Q()
 
+    // 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');
+
+            _.extend(options, _config);
+        }, function() {
+            // No config file: not a big deal
+            return Q();
+        });
+    })
+
     // Read readme
     .then(function() {
         return fs.readFile(path.join(options.input, "README.md"), "utf-8")
@@ -177,21 +193,6 @@ var generateBook = function(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');
-
-            _.extend(options, _config);
-        }, function() {
-            // No config file: not a big deal
-            return Q();
-        });
-    })
-
     // Clean output folder
     .then(function() {
         return fs.remove(options.output);

lib/generate/json/index.js

@@ -1,6 +1,7 @@
 var util = require("util");
 var path = require("path");
 var Q = require("q");
+var _ = require("lodash");
 
 var fs = require("../fs");
 var parse = require("../../parse");
@@ -41,17 +42,29 @@ Generator.prototype.convertFile = function(content, input) {
 };
 
 // Generate languages index
+// Contains the first languages readme and langs infos
 Generator.prototype.langsIndex = function(langs) {
     var that = this;
 
-    var json = {
-        langs: langs.list
-    };
+    if (langs.list.length == 0) return Q.reject("Need at least one language");
+
+    var mainLang = _.first(langs.list).lang;
+    console.log("Main language is", mainLang);
 
     return Q()
     .then(function() {
+        return fs.readFile(
+            path.join(that.options.output, mainLang, "README.json")
+        );
+    })
+    .then(function(content) {
+        var json = JSON.parse(content);
+        _.extend(json, {
+            langs: langs.list
+        });
+
         return fs.writeFile(
-            path.join(that.options.output, "langs.json"),
+            path.join(that.options.output, "README.json"),
             JSON.stringify(json, null, 4)
         );
     });

lib/generate/plugin.js

@@ -160,6 +160,16 @@ Plugin.fromList = function(names, root) {
     })
     .object()
     .value();
+    resources.html = {}
+
+    _.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);
+        })
+    });
 
     return Q({
         'list': plugins,
@@ -179,6 +189,11 @@ Plugin.fromList = function(names, root) {
 
             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");
         }
     });
 };
@@ -189,4 +204,4 @@ Plugin.defaults = [
     "mathjax"
 ];
 
-module.exports = Plugin;
+module.exports = Plugin;

lib/generate/site/index.js

@@ -81,6 +81,7 @@ Generator.prototype._writeTemplate = function(tpl, options, output, interpolate)
 
             plugins: that.plugins,
             pluginsConfig: JSON.stringify(that.options.pluginsConfig),
+            htmlSnippet: _.partialRight(that.plugins.html, that, options),
 
             options: that.options
         }, options));
@@ -237,9 +238,13 @@ Generator.prototype.writeCacheManifest = function() {
 };
 
 Generator.prototype.finish = function() {
-    return this.copyAssets()
-    .then(this.writeSearchIndex)
-    .then(this.writeCacheManifest);
+    var deferred = this.copyAssets().then(this.writeSearchIndex);
+
+    if (this.options.cache) {
+      deferred = deferred.then(this.writeCacheManifest);
+    }
+
+    return deferred;
 };
 
 module.exports = Generator;

lib/parse/progress.js

@@ -12,7 +12,7 @@ var calculProgress = function(navigation, current) {
         return nav;
     })
     .sortBy(function(nav) {
-        return nav.level;
+        return parseFloat(nav.level);
     })
     .map(function(nav, i) {
         // Calcul percent
@@ -27,7 +27,7 @@ var calculProgress = function(navigation, current) {
         } else if (done) {
             prevPercent = nav.percent;
         }
-        
+
         return nav;
     })
     .value();

lib/utils/links.js

@@ -19,6 +19,10 @@ var toAbsolute = function(_href, dir, outdir) {
     // make it relative to output
     _href = path.relative(outdir, _href);
 
+    if (process.platform === 'win32') {
+        _href = _href.replace(/\\/g, '/');
+    }
+
     return _href;
 };
 

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -20,10 +20,11 @@
         "semver": "2.2.1",
         "gaze": "~0.5.1",
         "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.3",
+        "gitbook-plugin-livereload": "0.0.1"
     },
     "devDependencies": {
         "mocha": "1.18.2",

theme/javascript/core/font-settings.js

@@ -30,40 +30,23 @@ define([
     };
 
     var enlargeFontSize = function(e){
-        var $bookBody = $(".book-body");
-
         if (fontState.size < 4){
-            $bookBody.toggleClass("font-size-"+fontState.size, false);
             fontState.size++;
-
-            $bookBody.toggleClass("font-size-"+fontState.size, true);
             fontState.save();
         }
     };
 
     var reduceFontSize = function(e){
-        var $bookBody = $(".book-body");
-
         if (fontState.size > 0){
-            $bookBody.toggleClass("font-size-"+fontState.size);
             fontState.size--;
-
-            $bookBody.toggleClass("font-size-"+fontState.size);
             fontState.save();
         }
     };
 
     var changeFontFamily = function(){
-        var $bookBody = $(".book-body");
         var index = $(this).data("font");
 
-        $bookBody.toggleClass("font-family-"+fontState.family);
-        $(".font-settings .font-family-list li:nth-child("+(fontState.family+1)+")")
-            .removeClass("active");
-
         fontState.family = index;
-        $bookBody.toggleClass("font-family-"+fontState.family);
-        $(this).addClass("active");
         fontState.save();
     };
 
@@ -81,6 +64,22 @@ define([
         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;
 
@@ -98,15 +97,10 @@ define([
         });
         fontState.save = function(){
             storage.set("fontState",fontState);
+            update();
         };
 
-        $bookBody.addClass("font-size-"+fontState.size);
-        $bookBody.addClass("font-family-"+fontState.family);
-
-        $(".font-settings .font-family-list li:nth-child("+(fontState.family+1)+")").addClass("active");
-
-        if(fontState.theme !== 0)
-            $book.addClass("color-theme-"+fontState.theme);
+        update();
 
         //Add event listeners
         $(document).on('click', "#enlarge-font-size", enlargeFontSize);
@@ -121,6 +115,7 @@ define([
     };
 
     return {
-        init: init
+        init: init,
+        update: update
     }
 });

theme/javascript/core/loading.js

@@ -2,11 +2,9 @@ define([
     "jQuery"
 ], function($) {
     var showLoading = function(p) {
-        var $book = $(".book");
-
-        $book.addClass("is-loading");
+        $(".book").addClass("is-loading");
         p.always(function() {
-            $book.removeClass("is-loading");
+            $(".book").removeClass("is-loading");
         });
 
         return p;

theme/javascript/core/navigation.js

@@ -3,12 +3,11 @@ define([
     "utils/url",
     "core/events",
     "core/state",
-    "core/search",
     "core/progress",
     "core/exercise",
     "core/quiz",
     "core/loading"
-], function($, URL, events, state, search, progress, exercises, quiz, loading) {
+], function($, URL, events, state, progress, exercises, quiz, loading) {
     var prev, next;
     var githubCountStars, githubCountWatch;
 
@@ -47,10 +46,12 @@ define([
             $("head").html(headContent);
 
             // 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
@@ -94,9 +95,6 @@ define([
         // Focus on content
         $pageWrapper.focus();
 
-        // Prepare search bar
-        search.prepare();
-
         // Update GitHub count
         if (state.githubId) {
             if (githubCountStars) {

theme/javascript/core/search.js

@@ -67,12 +67,10 @@ define([
             e.preventDefault();
             toggleSearch();
         });
-    };
 
-    var prepare = function() {
-        var $searchInput = $(".book-search input");
 
-        $searchInput.keyup(function(e) {
+        // Type in search bar
+        $(document).on("keyup", ".book-search input", function(e) {
             var key = (e.keyCode ? e.keyCode : e.which);
             var q = $(this).val();
 
@@ -89,13 +87,12 @@ define([
                     _.pluck(results, "path")
                 );
             }
-        });
-    }
+        })
+    };
 
     return {
         init: init,
         search: search,
-        toggle: toggleSearch,
-        prepare: prepare
+        toggle: toggleSearch
     };
 });

theme/javascript/core/sidebar.js

@@ -1,11 +1,10 @@
 define([
+    "jQuery",
     "lodash",
     "utils/storage",
     "utils/platform",
     "core/state"
-], function(_, storage, platform, state) {
-    var $summary = state.$book.find(".book-summary");
-
+], function($, _, storage, platform, state) {
     // Toggle sidebar with or withour animation
     var toggleSidebar = function(_state, animation) {
         if (state != null && isOpen() == _state) return;
@@ -38,6 +37,8 @@ define([
 
     // 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);
@@ -48,7 +49,6 @@ define([
     };
 
     return {
-        $el: $summary,
         init: init,
         toggle: toggleSidebar,
         filter: filterSummary

theme/stylesheets/book/body.less

@@ -59,28 +59,6 @@
                 min-height: calc(~"100% - 57px")
             }
         }
-        &.font-size-0{
-            font-size:@s-font-size;
-        }
-        &.font-size-1{
-            font-size:@m-font-size;
-        }
-        &.font-size-2{
-            font-size:@l-font-size;
-        }
-        &.font-size-3{
-            font-size:@xl-font-size;
-        }
-        &.font-size-4{
-            font-size:@xxl-font-size;
-        }
-
-        &.font-family-0{
-            font-family: @font-family-serif;
-        }
-        &.font-family-1{
-            font-family: @font-family-sans;
-        }
     }
 
     &.with-summary {
@@ -122,4 +100,37 @@
             }
         }
     }
+
+    &.font-size-0 {
+        .book-body {
+            font-size:@s-font-size;
+        }
+    }
+    &.font-size-1 {
+        .book-body {
+            font-size:@m-font-size;
+        }
+    }
+    &.font-size-2 {
+        .book-body {
+            font-size:@l-font-size;
+        }
+    }
+    &.font-size-3 {
+        .book-body {
+            font-size:@xl-font-size;
+        }
+    }
+    &.font-size-4 {
+        .book-body {
+            font-size:@xxl-font-size;
+        }
+    }
+
+    &.font-family-0{
+        font-family: @font-family-serif;
+    }
+    &.font-family-1{
+        font-family: @font-family-sans;
+    }
 }

theme/stylesheets/book/exercise.less

@@ -1,7 +1,7 @@
 .book .book-body .page-wrapper .page-inner {
     section.exercise {
         padding: 0px;
-        margin: 20px 0px;
+        margin: 20px 15px;
         border: 3px solid #2f8cde;
 
         .header {

theme/stylesheets/book/markdown.less

@@ -24,6 +24,7 @@
     padding-bottom: 25px;
     padding-top: 15px;
     color:@page-color;
+    letter-spacing: 0.01rem;
 
     & > *:first-child {
         margin-top: 0 !important; }

theme/stylesheets/book/navigation.less

@@ -13,15 +13,15 @@
         flex-direction: column;
 
         font-size: 40px;
-        color: rgba(0,0,0,0.5);
+        color: rgba(0,0,0,0.4);
 
         text-align: center;
 
         .transition(all 350ms ease);
 
         &:hover {
-            background-color: @body-pagination-background;
             text-decoration: none;
+            color: rgba(0,0,0,0.6);
         }
 
         &.navigation-next {
@@ -50,11 +50,9 @@
 }
 .book.color-theme-1 .book-body  {
     .navigation:hover{
-        background-color: @body-pagination-background-1;
     }
 }
 .book.color-theme-2 .book-body  {
     .navigation:hover{
-        background-color: @body-pagination-background-2;
     }
 }

theme/stylesheets/book/quiz.less

@@ -1,7 +1,7 @@
 .book .book-body .page-wrapper .page-inner {
     section.quiz {
         padding: 0px;
-        margin: 20px 0px;
+        margin: 20px 15px;
         border: 3px solid #2f8cde;
 
         .header {

theme/stylesheets/variables.less

@@ -13,7 +13,6 @@
 
 // Body
 @body-background:                     white;
-@body-pagination-background:          hsl(207, 15%, 95%);
 
 // Sidebar
 @sidebar-width:                       250px;
@@ -91,12 +90,12 @@
 @xl-font-size:												2.2rem;
 @xxl-font-size:												4.0rem;
 
-/*                                                       
-,--------.,--.                                         
-'--.  .--'|  ,---.  ,---. ,--,--,--. ,---.  ,---. .--. 
-   |  |   |  .-.  || .-. :|        || .-. :(  .-' '--' 
-   |  |   |  | |  |\   --.|  |  |  |\   --..-'  `).--. 
-   `--'   `--' `--' `----'`--`--`--' `----'`----' '--' 
+/*
+,--------.,--.
+'--.  .--'|  ,---.  ,---. ,--,--,--. ,---.  ,---. .--.
+   |  |   |  .-.  || .-. :|        || .-. :(  .-' '--'
+   |  |   |  | |  |\   --.|  |  |  |\   --..-'  `).--.
+   `--'   `--' `--' `----'`--`--`--' `----'`----' '--'
 */
 // Header
 @header-color-1:                        #AFA790;
@@ -113,8 +112,6 @@
 // Body
 @body-background-1:                     #F3EACB;
 @body-background-2:                     #1d1f21;
-@body-pagination-background-1:          #FFFAEA;
-@body-pagination-background-2:          #33404D;
 
 // Sidebar
 @sidebar-color-1:                       #AFA790;

theme/templates/includes/book/header.html

@@ -1,9 +1,9 @@
 <div class="book-header">
     <!-- Actions Left -->
+    <a href="#" class="btn pull-left toggle-summary" aria-label="Toggle summary"><i class="fa fa-align-justify"></i></a>
     {% if options.links.home !== false and (options.links.home != null or githubId) %}
     <a href="{{ options.links.home|default(githubHost+githubId) }}" target="_blank" class="btn pull-left home-bookmark" aria-label="GitHub home"><i class="fa fa-bookmark-o"></i></a>
     {% endif %}
-    <a href="#" class="btn pull-left toggle-summary" aria-label="Toggle summary"><i class="fa fa-align-justify"></i></a>
     <a href="#" class="btn pull-left toggle-search" aria-label="Toggle search"><i class="fa fa-search"></i></a>
     <span id="font-settings-wrapper">
         <a href="#" class="btn pull-left toggle-font-settings" aria-label="Toggle font settings"><i class="fa fa-font"></i>

theme/templates/includes/book/summary.html

@@ -3,25 +3,29 @@
         <input type="text" placeholder="Search" class="form-control" />
     </div>
     <ul class="summary">
+        {% set _divider = false %}
         {% if options.links.about !== false && (options.links.about || githubId) %}
+        {% set _divider = true %}
         <li>
             <a href="{{ options.links.about|default(githubHost+githubAuthor) }}" target="blank" class="author-link">About the author</a>
         </li>
         {% endif %}
 
         {% 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>
         </li>
         {% endif %}
 
         {% if options.links.contribute !== false && (options.links.contribute || githubId) %}
+        {% set _divider = true %}
         <li>
             <a href="{{ options.links.contribute|default(githubHost+githubId+"/edit/master/"+_input) }}" target="blank" class="contribute-link">Edit and Contribute</a>
         </li>
         {% endif %}
 
-        {% if options.links.contribute || options.links.issues || options.links.about %}
+        {% if _divider %}
         <li class="divider"></li>
         {% endif %}
 

theme/templates/layout.html

@@ -1,6 +1,8 @@
 <!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#">
+        {{ htmlSnippet("head:start")|default("") }}
         {% block head %}
         <meta charset="UTF-8">
         <title>{% block title %} | {{ title }}{% endblock %}</title>
@@ -33,8 +35,10 @@
 
         <link rel="shortcut icon" href="{{ staticBase }}/images/favicon.ico" type="image/x-icon">
         {% endblock %}
+        {{ htmlSnippet("head:end")|default("") }}
     </head>
     <body>
+        {{ htmlSnippet("body:start")|default("") }}
         {% block style %}
         <link rel="stylesheet" href="{{ staticBase }}/style.css">
         {% endblock %}
@@ -45,5 +49,7 @@
         <script src="{{ staticBase }}/jsrepl/jsrepl.js" id="jsrepl-script"></script>
         <script src="{{ staticBase }}/app.js"></script>
         {% endblock %}
+        {{ htmlSnippet("body:end")|default("") }}
     </body>
+    {{ htmlSnippet("html:end")|default("") }}
 </html>

theme/templates/site.html

@@ -1,6 +1,6 @@
 {% extends "layout.html" %}
 
-{% block htmlTag %}manifest="{{ basePath }}/manifest.appcache"{% endblock %}
+{% block htmlTag %}{% if options.cache !== false %}manifest="{{ basePath }}/manifest.appcache"{% endif %}{% endblock %}
 {% block title %}{{ progress.current.title }}{% parent %}{% endblock %}
 {% block content %}
     <div class="book" {% if githubId %}data-github="{{ githubId }}"{% endif %} data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">