Bump version to 0.1.0

Useful for linking to blobs and other files …

Gruntfile.js

@@ -33,6 +33,7 @@ module.exports = function (grunt) {
                         "jQuery": 'vendors/jquery',
                         "lodash": 'vendors/lodash',
                         "requireLib": 'vendors/require',
+                        "Mousetrap": 'vendors/mousetrap'
                     },
                     shim: {
                         'jQuery': {
@@ -40,6 +41,9 @@ module.exports = function (grunt) {
                         },
                         'lodash': {
                             exports: '_'
+                        },
+                        'Mousetrap': {
+                            exports: 'Mousetrap'
                         }
                     }
                 }

README.md

@@ -3,6 +3,8 @@ GitBook
 
 GiBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](http://gitbookio.github.io/javascript/).
 
+![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
+
 ## How to use it:
 
 GitBook can be installed from **NPM** using:

assets/javascript/app.js

@@ -1,21 +1,31 @@
 require([
     "jQuery",
+    "utils/storage",
     "utils/analytic",
+    "utils/sharing",
+
     "core/state",
+    "core/keyboard",
     "core/exercise",
     "core/progress",
     "core/sidebar"
-], function($, analytic, _state, exercise, progress, sidebar){
+], function($, storage, analytic, sharing, _state, keyboard, exercise, progress, sidebar){
     $(document).ready(function() {
         var state = _state();
         var $book = state.$book;
 
+        // Initialize storage
+        storage.setBaseKey(state.githubId);
+
         // Tract page view
         analytic.track("View");
 
         // Init sidebar
         sidebar.init();
 
+        // Init keyboard
+        keyboard.init();
+
         // Star and watch count
         $.getJSON("https://api.github.com/repos/"+state.githubId)
         .done(function(repo) {
@@ -26,7 +36,13 @@ require([
         // Bind exercise
         exercise.init();
 
+        // Bind sharing button
+        sharing.init();
+
         // Show progress
         progress.show();
+
+        // Focus on content
+        $(".book-body").focus();
     });
 });

assets/javascript/core/exercise.js

@@ -32,6 +32,7 @@ define([
             e.preventDefault();
 
             editor.setValue(codeSolution);
+            editor.gotoLine(0);
         });
     };
 

assets/javascript/core/keyboard.js

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

assets/javascript/core/navigation.js

@@ -0,0 +1,17 @@
+define([
+    "jQuery"
+], function($) {
+    var goNext = function() {
+        var url = $("link[rel='next']").attr("href");
+        if (url) location.href = url;
+    };
+    var goPrev = function() {
+        var url = $("link[rel='prev']").attr("href");
+        if (url) location.href = url;
+    };
+
+    return {
+        goNext: goNext,
+        goPrev: goPrev
+    };
+});

assets/javascript/core/sidebar.js

@@ -6,6 +6,7 @@ define([
 
     // Toggle sidebar with or withour animation
     var toggleSidebar = function(_state, animation) {
+        if (-state != null && isOpen() == _state) return;
         if (animation == null) animation = true;
 
         var $book = state().$book;
@@ -31,7 +32,7 @@ define([
         });
 
         // Init last state if not mobile and not homepage
-        if (!isOpen()) toggleSidebar(platform.isMobile ? false : storage.get("sidebar", false), false);
+        toggleSidebar(platform.isMobile ? false : storage.get("sidebar", true), false);
     };
 
     return {

assets/javascript/utils/sharing.js

@@ -0,0 +1,33 @@
+define([
+    "jQuery"
+], function($) {
+    var url = location.href;
+    var title = $("title").text();
+
+    var types = {
+        "twitter": function($el) {
+            window.open("http://twitter.com/home?status="+encodeURIComponent(title+" "+url))
+        },
+        "facebook": function($el) {
+            window.open("http://www.facebook.com/sharer/sharer.php?s=100&p[url]="+encodeURIComponent(url))
+        },
+        "google-plus": function($el) {
+            window.open("https://plus.google.com/share?url="+encodeURIComponent(url))
+        }
+    };
+
+
+    // Bind all sharing button
+    var init = function() {
+        $("a[data-sharing]").click(function(e) {
+            if (e) e.preventDefault();
+            var type = $(this).data("sharing");
+
+            types[type]($(this));
+        })
+    };
+
+    return {
+        init: init
+    };
+});

assets/javascript/utils/storage.js

@@ -1,12 +1,19 @@
 define(function(){
+    var baseKey = "";
+
     /*
      * Simple module for storing data in the browser's local storage
      */
     return {
+        setBaseKey: function(key) {
+            baseKey = key;
+        },
         set: function(key, value) {
+            key = baseKey+":"+key;
             localStorage[key] = JSON.stringify(value);
         },
         get: function(key, def) {
+            key = baseKey+":"+key;
             try {
                 return JSON.parse(localStorage[key]) || def;
             } catch(err) {
@@ -14,6 +21,7 @@ define(function(){
             }
         },
         remove: function(key) {
+            key = baseKey+":"+key;
             localStorage.removeItem(key);
         }
     };

assets/javascript/vendors/mousetrap.js

@@ -0,0 +1,953 @@
+/*global define:false */
+/**
+ * Copyright 2013 Craig Campbell
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Mousetrap is a simple keyboard shortcut library for Javascript with
+ * no external dependencies
+ *
+ * @version 1.4.6
+ * @url craig.is/killing/mice
+ */
+(function(window, document, undefined) {
+
+    /**
+     * mapping of special keycodes to their corresponding keys
+     *
+     * everything in this dictionary cannot use keypress events
+     * so it has to be here to map to the correct keycodes for
+     * keyup/keydown events
+     *
+     * @type {Object}
+     */
+    var _MAP = {
+            8: 'backspace',
+            9: 'tab',
+            13: 'enter',
+            16: 'shift',
+            17: 'ctrl',
+            18: 'alt',
+            20: 'capslock',
+            27: 'esc',
+            32: 'space',
+            33: 'pageup',
+            34: 'pagedown',
+            35: 'end',
+            36: 'home',
+            37: 'left',
+            38: 'up',
+            39: 'right',
+            40: 'down',
+            45: 'ins',
+            46: 'del',
+            91: 'meta',
+            93: 'meta',
+            224: 'meta'
+        },
+
+        /**
+         * mapping for special characters so they can support
+         *
+         * this dictionary is only used incase you want to bind a
+         * keyup or keydown event to one of these keys
+         *
+         * @type {Object}
+         */
+        _KEYCODE_MAP = {
+            106: '*',
+            107: '+',
+            109: '-',
+            110: '.',
+            111 : '/',
+            186: ';',
+            187: '=',
+            188: ',',
+            189: '-',
+            190: '.',
+            191: '/',
+            192: '`',
+            219: '[',
+            220: '\\',
+            221: ']',
+            222: '\''
+        },
+
+        /**
+         * this is a mapping of keys that require shift on a US keypad
+         * back to the non shift equivelents
+         *
+         * this is so you can use keyup events with these keys
+         *
+         * note that this will only work reliably on US keyboards
+         *
+         * @type {Object}
+         */
+        _SHIFT_MAP = {
+            '~': '`',
+            '!': '1',
+            '@': '2',
+            '#': '3',
+            '$': '4',
+            '%': '5',
+            '^': '6',
+            '&': '7',
+            '*': '8',
+            '(': '9',
+            ')': '0',
+            '_': '-',
+            '+': '=',
+            ':': ';',
+            '\"': '\'',
+            '<': ',',
+            '>': '.',
+            '?': '/',
+            '|': '\\'
+        },
+
+        /**
+         * this is a list of special strings you can use to map
+         * to modifier keys when you specify your keyboard shortcuts
+         *
+         * @type {Object}
+         */
+        _SPECIAL_ALIASES = {
+            'option': 'alt',
+            'command': 'meta',
+            'return': 'enter',
+            'escape': 'esc',
+            'mod': /Mac|iPod|iPhone|iPad/.test(navigator.platform) ? 'meta' : 'ctrl'
+        },
+
+        /**
+         * variable to store the flipped version of _MAP from above
+         * needed to check if we should use keypress or not when no action
+         * is specified
+         *
+         * @type {Object|undefined}
+         */
+        _REVERSE_MAP,
+
+        /**
+         * a list of all the callbacks setup via Mousetrap.bind()
+         *
+         * @type {Object}
+         */
+        _callbacks = {},
+
+        /**
+         * direct map of string combinations to callbacks used for trigger()
+         *
+         * @type {Object}
+         */
+        _directMap = {},
+
+        /**
+         * keeps track of what level each sequence is at since multiple
+         * sequences can start out with the same sequence
+         *
+         * @type {Object}
+         */
+        _sequenceLevels = {},
+
+        /**
+         * variable to store the setTimeout call
+         *
+         * @type {null|number}
+         */
+        _resetTimer,
+
+        /**
+         * temporary state where we will ignore the next keyup
+         *
+         * @type {boolean|string}
+         */
+        _ignoreNextKeyup = false,
+
+        /**
+         * temporary state where we will ignore the next keypress
+         *
+         * @type {boolean}
+         */
+        _ignoreNextKeypress = false,
+
+        /**
+         * are we currently inside of a sequence?
+         * type of action ("keyup" or "keydown" or "keypress") or false
+         *
+         * @type {boolean|string}
+         */
+        _nextExpectedAction = false;
+
+    /**
+     * loop through the f keys, f1 to f19 and add them to the map
+     * programatically
+     */
+    for (var i = 1; i < 20; ++i) {
+        _MAP[111 + i] = 'f' + i;
+    }
+
+    /**
+     * loop through to map numbers on the numeric keypad
+     */
+    for (i = 0; i <= 9; ++i) {
+        _MAP[i + 96] = i;
+    }
+
+    /**
+     * cross browser add event method
+     *
+     * @param {Element|HTMLDocument} object
+     * @param {string} type
+     * @param {Function} callback
+     * @returns void
+     */
+    function _addEvent(object, type, callback) {
+        if (object.addEventListener) {
+            object.addEventListener(type, callback, false);
+            return;
+        }
+
+        object.attachEvent('on' + type, callback);
+    }
+
+    /**
+     * takes the event and returns the key character
+     *
+     * @param {Event} e
+     * @return {string}
+     */
+    function _characterFromEvent(e) {
+
+        // for keypress events we should return the character as is
+        if (e.type == 'keypress') {
+            var character = String.fromCharCode(e.which);
+
+            // if the shift key is not pressed then it is safe to assume
+            // that we want the character to be lowercase.  this means if
+            // you accidentally have caps lock on then your key bindings
+            // will continue to work
+            //
+            // the only side effect that might not be desired is if you
+            // bind something like 'A' cause you want to trigger an
+            // event when capital A is pressed caps lock will no longer
+            // trigger the event.  shift+a will though.
+            if (!e.shiftKey) {
+                character = character.toLowerCase();
+            }
+
+            return character;
+        }
+
+        // for non keypress events the special maps are needed
+        if (_MAP[e.which]) {
+            return _MAP[e.which];
+        }
+
+        if (_KEYCODE_MAP[e.which]) {
+            return _KEYCODE_MAP[e.which];
+        }
+
+        // if it is not in the special map
+
+        // with keydown and keyup events the character seems to always
+        // come in as an uppercase character whether you are pressing shift
+        // or not.  we should make sure it is always lowercase for comparisons
+        return String.fromCharCode(e.which).toLowerCase();
+    }
+
+    /**
+     * checks if two arrays are equal
+     *
+     * @param {Array} modifiers1
+     * @param {Array} modifiers2
+     * @returns {boolean}
+     */
+    function _modifiersMatch(modifiers1, modifiers2) {
+        return modifiers1.sort().join(',') === modifiers2.sort().join(',');
+    }
+
+    /**
+     * resets all sequence counters except for the ones passed in
+     *
+     * @param {Object} doNotReset
+     * @returns void
+     */
+    function _resetSequences(doNotReset) {
+        doNotReset = doNotReset || {};
+
+        var activeSequences = false,
+            key;
+
+        for (key in _sequenceLevels) {
+            if (doNotReset[key]) {
+                activeSequences = true;
+                continue;
+            }
+            _sequenceLevels[key] = 0;
+        }
+
+        if (!activeSequences) {
+            _nextExpectedAction = false;
+        }
+    }
+
+    /**
+     * finds all callbacks that match based on the keycode, modifiers,
+     * and action
+     *
+     * @param {string} character
+     * @param {Array} modifiers
+     * @param {Event|Object} e
+     * @param {string=} sequenceName - name of the sequence we are looking for
+     * @param {string=} combination
+     * @param {number=} level
+     * @returns {Array}
+     */
+    function _getMatches(character, modifiers, e, sequenceName, combination, level) {
+        var i,
+            callback,
+            matches = [],
+            action = e.type;
+
+        // if there are no events related to this keycode
+        if (!_callbacks[character]) {
+            return [];
+        }
+
+        // if a modifier key is coming up on its own we should allow it
+        if (action == 'keyup' && _isModifier(character)) {
+            modifiers = [character];
+        }
+
+        // loop through all callbacks for the key that was pressed
+        // and see if any of them match
+        for (i = 0; i < _callbacks[character].length; ++i) {
+            callback = _callbacks[character][i];
+
+            // if a sequence name is not specified, but this is a sequence at
+            // the wrong level then move onto the next match
+            if (!sequenceName && callback.seq && _sequenceLevels[callback.seq] != callback.level) {
+                continue;
+            }
+
+            // if the action we are looking for doesn't match the action we got
+            // then we should keep going
+            if (action != callback.action) {
+                continue;
+            }
+
+            // if this is a keypress event and the meta key and control key
+            // are not pressed that means that we need to only look at the
+            // character, otherwise check the modifiers as well
+            //
+            // chrome will not fire a keypress if meta or control is down
+            // safari will fire a keypress if meta or meta+shift is down
+            // firefox will fire a keypress if meta or control is down
+            if ((action == 'keypress' && !e.metaKey && !e.ctrlKey) || _modifiersMatch(modifiers, callback.modifiers)) {
+
+                // when you bind a combination or sequence a second time it
+                // should overwrite the first one.  if a sequenceName or
+                // combination is specified in this call it does just that
+                //
+                // @todo make deleting its own method?
+                var deleteCombo = !sequenceName && callback.combo == combination;
+                var deleteSequence = sequenceName && callback.seq == sequenceName && callback.level == level;
+                if (deleteCombo || deleteSequence) {
+                    _callbacks[character].splice(i, 1);
+                }
+
+                matches.push(callback);
+            }
+        }
+
+        return matches;
+    }
+
+    /**
+     * takes a key event and figures out what the modifiers are
+     *
+     * @param {Event} e
+     * @returns {Array}
+     */
+    function _eventModifiers(e) {
+        var modifiers = [];
+
+        if (e.shiftKey) {
+            modifiers.push('shift');
+        }
+
+        if (e.altKey) {
+            modifiers.push('alt');
+        }
+
+        if (e.ctrlKey) {
+            modifiers.push('ctrl');
+        }
+
+        if (e.metaKey) {
+            modifiers.push('meta');
+        }
+
+        return modifiers;
+    }
+
+    /**
+     * prevents default for this event
+     *
+     * @param {Event} e
+     * @returns void
+     */
+    function _preventDefault(e) {
+        if (e.preventDefault) {
+            e.preventDefault();
+            return;
+        }
+
+        e.returnValue = false;
+    }
+
+    /**
+     * stops propogation for this event
+     *
+     * @param {Event} e
+     * @returns void
+     */
+    function _stopPropagation(e) {
+        if (e.stopPropagation) {
+            e.stopPropagation();
+            return;
+        }
+
+        e.cancelBubble = true;
+    }
+
+    /**
+     * actually calls the callback function
+     *
+     * if your callback function returns false this will use the jquery
+     * convention - prevent default and stop propogation on the event
+     *
+     * @param {Function} callback
+     * @param {Event} e
+     * @returns void
+     */
+    function _fireCallback(callback, e, combo, sequence) {
+
+        // if this event should not happen stop here
+        if (Mousetrap.stopCallback(e, e.target || e.srcElement, combo, sequence)) {
+            return;
+        }
+
+        if (callback(e, combo) === false) {
+            _preventDefault(e);
+            _stopPropagation(e);
+        }
+    }
+
+    /**
+     * handles a character key event
+     *
+     * @param {string} character
+     * @param {Array} modifiers
+     * @param {Event} e
+     * @returns void
+     */
+    function _handleKey(character, modifiers, e) {
+        var callbacks = _getMatches(character, modifiers, e),
+            i,
+            doNotReset = {},
+            maxLevel = 0,
+            processedSequenceCallback = false;
+
+        // Calculate the maxLevel for sequences so we can only execute the longest callback sequence
+        for (i = 0; i < callbacks.length; ++i) {
+            if (callbacks[i].seq) {
+                maxLevel = Math.max(maxLevel, callbacks[i].level);
+            }
+        }
+
+        // loop through matching callbacks for this key event
+        for (i = 0; i < callbacks.length; ++i) {
+
+            // fire for all sequence callbacks
+            // this is because if for example you have multiple sequences
+            // bound such as "g i" and "g t" they both need to fire the
+            // callback for matching g cause otherwise you can only ever
+            // match the first one
+            if (callbacks[i].seq) {
+
+                // only fire callbacks for the maxLevel to prevent
+                // subsequences from also firing
+                //
+                // for example 'a option b' should not cause 'option b' to fire
+                // even though 'option b' is part of the other sequence
+                //
+                // any sequences that do not match here will be discarded
+                // below by the _resetSequences call
+                if (callbacks[i].level != maxLevel) {
+                    continue;
+                }
+
+                processedSequenceCallback = true;
+
+                // keep a list of which sequences were matches for later
+                doNotReset[callbacks[i].seq] = 1;
+                _fireCallback(callbacks[i].callback, e, callbacks[i].combo, callbacks[i].seq);
+                continue;
+            }
+
+            // if there were no sequence matches but we are still here
+            // that means this is a regular match so we should fire that
+            if (!processedSequenceCallback) {
+                _fireCallback(callbacks[i].callback, e, callbacks[i].combo);
+            }
+        }
+
+        // if the key you pressed matches the type of sequence without
+        // being a modifier (ie "keyup" or "keypress") then we should
+        // reset all sequences that were not matched by this event
+        //
+        // this is so, for example, if you have the sequence "h a t" and you
+        // type "h e a r t" it does not match.  in this case the "e" will
+        // cause the sequence to reset
+        //
+        // modifier keys are ignored because you can have a sequence
+        // that contains modifiers such as "enter ctrl+space" and in most
+        // cases the modifier key will be pressed before the next key
+        //
+        // also if you have a sequence such as "ctrl+b a" then pressing the
+        // "b" key will trigger a "keypress" and a "keydown"
+        //
+        // the "keydown" is expected when there is a modifier, but the
+        // "keypress" ends up matching the _nextExpectedAction since it occurs
+        // after and that causes the sequence to reset
+        //
+        // we ignore keypresses in a sequence that directly follow a keydown
+        // for the same character
+        var ignoreThisKeypress = e.type == 'keypress' && _ignoreNextKeypress;
+        if (e.type == _nextExpectedAction && !_isModifier(character) && !ignoreThisKeypress) {
+            _resetSequences(doNotReset);
+        }
+
+        _ignoreNextKeypress = processedSequenceCallback && e.type == 'keydown';
+    }
+
+    /**
+     * handles a keydown event
+     *
+     * @param {Event} e
+     * @returns void
+     */
+    function _handleKeyEvent(e) {
+
+        // normalize e.which for key events
+        // @see http://stackoverflow.com/questions/4285627/javascript-keycode-vs-charcode-utter-confusion
+        if (typeof e.which !== 'number') {
+            e.which = e.keyCode;
+        }
+
+        var character = _characterFromEvent(e);
+
+        // no character found then stop
+        if (!character) {
+            return;
+        }
+
+        // need to use === for the character check because the character can be 0
+        if (e.type == 'keyup' && _ignoreNextKeyup === character) {
+            _ignoreNextKeyup = false;
+            return;
+        }
+
+        Mousetrap.handleKey(character, _eventModifiers(e), e);
+    }
+
+    /**
+     * determines if the keycode specified is a modifier key or not
+     *
+     * @param {string} key
+     * @returns {boolean}
+     */
+    function _isModifier(key) {
+        return key == 'shift' || key == 'ctrl' || key == 'alt' || key == 'meta';
+    }
+
+    /**
+     * called to set a 1 second timeout on the specified sequence
+     *
+     * this is so after each key press in the sequence you have 1 second
+     * to press the next key before you have to start over
+     *
+     * @returns void
+     */
+    function _resetSequenceTimer() {
+        clearTimeout(_resetTimer);
+        _resetTimer = setTimeout(_resetSequences, 1000);
+    }
+
+    /**
+     * reverses the map lookup so that we can look for specific keys
+     * to see what can and can't use keypress
+     *
+     * @return {Object}
+     */
+    function _getReverseMap() {
+        if (!_REVERSE_MAP) {
+            _REVERSE_MAP = {};
+            for (var key in _MAP) {
+
+                // pull out the numeric keypad from here cause keypress should
+                // be able to detect the keys from the character
+                if (key > 95 && key < 112) {
+                    continue;
+                }
+
+                if (_MAP.hasOwnProperty(key)) {
+                    _REVERSE_MAP[_MAP[key]] = key;
+                }
+            }
+        }
+        return _REVERSE_MAP;
+    }
+
+    /**
+     * picks the best action based on the key combination
+     *
+     * @param {string} key - character for key
+     * @param {Array} modifiers
+     * @param {string=} action passed in
+     */
+    function _pickBestAction(key, modifiers, action) {
+
+        // if no action was picked in we should try to pick the one
+        // that we think would work best for this key
+        if (!action) {
+            action = _getReverseMap()[key] ? 'keydown' : 'keypress';
+        }
+
+        // modifier keys don't work as expected with keypress,
+        // switch to keydown
+        if (action == 'keypress' && modifiers.length) {
+            action = 'keydown';
+        }
+
+        return action;
+    }
+
+    /**
+     * binds a key sequence to an event
+     *
+     * @param {string} combo - combo specified in bind call
+     * @param {Array} keys
+     * @param {Function} callback
+     * @param {string=} action
+     * @returns void
+     */
+    function _bindSequence(combo, keys, callback, action) {
+
+        // start off by adding a sequence level record for this combination
+        // and setting the level to 0
+        _sequenceLevels[combo] = 0;
+
+        /**
+         * callback to increase the sequence level for this sequence and reset
+         * all other sequences that were active
+         *
+         * @param {string} nextAction
+         * @returns {Function}
+         */
+        function _increaseSequence(nextAction) {
+            return function() {
+                _nextExpectedAction = nextAction;
+                ++_sequenceLevels[combo];
+                _resetSequenceTimer();
+            };
+        }
+
+        /**
+         * wraps the specified callback inside of another function in order
+         * to reset all sequence counters as soon as this sequence is done
+         *
+         * @param {Event} e
+         * @returns void
+         */
+        function _callbackAndReset(e) {
+            _fireCallback(callback, e, combo);
+
+            // we should ignore the next key up if the action is key down
+            // or keypress.  this is so if you finish a sequence and
+            // release the key the final key will not trigger a keyup
+            if (action !== 'keyup') {
+                _ignoreNextKeyup = _characterFromEvent(e);
+            }
+
+            // weird race condition if a sequence ends with the key
+            // another sequence begins with
+            setTimeout(_resetSequences, 10);
+        }
+
+        // loop through keys one at a time and bind the appropriate callback
+        // function.  for any key leading up to the final one it should
+        // increase the sequence. after the final, it should reset all sequences
+        //
+        // if an action is specified in the original bind call then that will
+        // be used throughout.  otherwise we will pass the action that the
+        // next key in the sequence should match.  this allows a sequence
+        // to mix and match keypress and keydown events depending on which
+        // ones are better suited to the key provided
+        for (var i = 0; i < keys.length; ++i) {
+            var isFinal = i + 1 === keys.length;
+            var wrappedCallback = isFinal ? _callbackAndReset : _increaseSequence(action || _getKeyInfo(keys[i + 1]).action);
+            _bindSingle(keys[i], wrappedCallback, action, combo, i);
+        }
+    }
+
+    /**
+     * Converts from a string key combination to an array
+     *
+     * @param  {string} combination like "command+shift+l"
+     * @return {Array}
+     */
+    function _keysFromString(combination) {
+        if (combination === '+') {
+            return ['+'];
+        }
+
+        return combination.split('+');
+    }
+
+    /**
+     * Gets info for a specific key combination
+     *
+     * @param  {string} combination key combination ("command+s" or "a" or "*")
+     * @param  {string=} action
+     * @returns {Object}
+     */
+    function _getKeyInfo(combination, action) {
+        var keys,
+            key,
+            i,
+            modifiers = [];
+
+        // take the keys from this pattern and figure out what the actual
+        // pattern is all about
+        keys = _keysFromString(combination);
+
+        for (i = 0; i < keys.length; ++i) {
+            key = keys[i];
+
+            // normalize key names
+            if (_SPECIAL_ALIASES[key]) {
+                key = _SPECIAL_ALIASES[key];
+            }
+
+            // if this is not a keypress event then we should
+            // be smart about using shift keys
+            // this will only work for US keyboards however
+            if (action && action != 'keypress' && _SHIFT_MAP[key]) {
+                key = _SHIFT_MAP[key];
+                modifiers.push('shift');
+            }
+
+            // if this key is a modifier then add it to the list of modifiers
+            if (_isModifier(key)) {
+                modifiers.push(key);
+            }
+        }
+
+        // depending on what the key combination is
+        // we will try to pick the best event for it
+        action = _pickBestAction(key, modifiers, action);
+
+        return {
+            key: key,
+            modifiers: modifiers,
+            action: action
+        };
+    }
+
+    /**
+     * binds a single keyboard combination
+     *
+     * @param {string} combination
+     * @param {Function} callback
+     * @param {string=} action
+     * @param {string=} sequenceName - name of sequence if part of sequence
+     * @param {number=} level - what part of the sequence the command is
+     * @returns void
+     */
+    function _bindSingle(combination, callback, action, sequenceName, level) {
+
+        // store a direct mapped reference for use with Mousetrap.trigger
+        _directMap[combination + ':' + action] = callback;
+
+        // make sure multiple spaces in a row become a single space
+        combination = combination.replace(/\s+/g, ' ');
+
+        var sequence = combination.split(' '),
+            info;
+
+        // if this pattern is a sequence of keys then run through this method
+        // to reprocess each pattern one key at a time
+        if (sequence.length > 1) {
+            _bindSequence(combination, sequence, callback, action);
+            return;
+        }
+
+        info = _getKeyInfo(combination, action);
+
+        // make sure to initialize array if this is the first time
+        // a callback is added for this key
+        _callbacks[info.key] = _callbacks[info.key] || [];
+
+        // remove an existing match if there is one
+        _getMatches(info.key, info.modifiers, {type: info.action}, sequenceName, combination, level);
+
+        // add this call back to the array
+        // if it is a sequence put it at the beginning
+        // if not put it at the end
+        //
+        // this is important because the way these are processed expects
+        // the sequence ones to come first
+        _callbacks[info.key][sequenceName ? 'unshift' : 'push']({
+            callback: callback,
+            modifiers: info.modifiers,
+            action: info.action,
+            seq: sequenceName,
+            level: level,
+            combo: combination
+        });
+    }
+
+    /**
+     * binds multiple combinations to the same callback
+     *
+     * @param {Array} combinations
+     * @param {Function} callback
+     * @param {string|undefined} action
+     * @returns void
+     */
+    function _bindMultiple(combinations, callback, action) {
+        for (var i = 0; i < combinations.length; ++i) {
+            _bindSingle(combinations[i], callback, action);
+        }
+    }
+
+    // start!
+    _addEvent(document, 'keypress', _handleKeyEvent);
+    _addEvent(document, 'keydown', _handleKeyEvent);
+    _addEvent(document, 'keyup', _handleKeyEvent);
+
+    var Mousetrap = {
+
+        /**
+         * binds an event to mousetrap
+         *
+         * can be a single key, a combination of keys separated with +,
+         * an array of keys, or a sequence of keys separated by spaces
+         *
+         * be sure to list the modifier keys first to make sure that the
+         * correct key ends up getting bound (the last key in the pattern)
+         *
+         * @param {string|Array} keys
+         * @param {Function} callback
+         * @param {string=} action - 'keypress', 'keydown', or 'keyup'
+         * @returns void
+         */
+        bind: function(keys, callback, action) {
+            keys = keys instanceof Array ? keys : [keys];
+            _bindMultiple(keys, callback, action);
+            return this;
+        },
+
+        /**
+         * unbinds an event to mousetrap
+         *
+         * the unbinding sets the callback function of the specified key combo
+         * to an empty function and deletes the corresponding key in the
+         * _directMap dict.
+         *
+         * TODO: actually remove this from the _callbacks dictionary instead
+         * of binding an empty function
+         *
+         * the keycombo+action has to be exactly the same as
+         * it was defined in the bind method
+         *
+         * @param {string|Array} keys
+         * @param {string} action
+         * @returns void
+         */
+        unbind: function(keys, action) {
+            return Mousetrap.bind(keys, function() {}, action);
+        },
+
+        /**
+         * triggers an event that has already been bound
+         *
+         * @param {string} keys
+         * @param {string=} action
+         * @returns void
+         */
+        trigger: function(keys, action) {
+            if (_directMap[keys + ':' + action]) {
+                _directMap[keys + ':' + action]({}, keys);
+            }
+            return this;
+        },
+
+        /**
+         * resets the library back to its initial state.  this is useful
+         * if you want to clear out the current keyboard shortcuts and bind
+         * new ones - for example if you switch to another page
+         *
+         * @returns void
+         */
+        reset: function() {
+            _callbacks = {};
+            _directMap = {};
+            return this;
+        },
+
+       /**
+        * should we stop this event before firing off callbacks
+        *
+        * @param {Event} e
+        * @param {Element} element
+        * @return {boolean}
+        */
+        stopCallback: function(e, element) {
+
+            // if the element has the class "mousetrap" then no need to stop
+            if ((' ' + element.className + ' ').indexOf(' mousetrap ') > -1) {
+                return false;
+            }
+
+            // stop for input, select, and textarea
+            return element.tagName == 'INPUT' || element.tagName == 'SELECT' || element.tagName == 'TEXTAREA' || element.isContentEditable;
+        },
+
+        /**
+         * exposes _handleKey publicly so it can be overwritten by extensions
+         */
+        handleKey: _handleKey
+    };
+
+    // expose mousetrap to the global object
+    window.Mousetrap = Mousetrap;
+
+    // expose mousetrap as an AMD module
+    if (typeof define === 'function' && define.amd) {
+        define(Mousetrap);
+    }
+}) (window, document);

assets/stylesheets/book/progress.less

@@ -74,6 +74,14 @@
                     background: @brand-success;
                     box-shadow: none;
                 }
+
+                @media (max-width: 800px) {
+                    display: none;
+
+                    &.new-chapter {
+                        display: block;
+                    }
+                }
             }
         }
     }

bin/gitbook.js

@@ -31,32 +31,41 @@ prog
 .action(buildFunc = function(dir, options) {
     dir = dir || process.cwd();
     outputDir = options.output || path.join(dir, '_book');
-    
+
     console.log('Starting build ...');
     // Get repo's URL
     return utils.gitURL(dir)
     .then(function(url) {
         // Get ID of repo
         return utils.githubID(url);
+    }, function(err) {
+        return null;
     })
     .then(function(repoID) {
-        var parts = repoID.split('/', 2);
+        var githubID = options.github || repoID;
+
+        if(!githubID) {
+            throw new Error('Needs a githubID (username/repo). Either set repo origin to a github repo or use the -g flag');
+        }
+
+        var parts = githubID.split('/', 2);
         var user = parts[0], repo = parts[1];
 
+        var title = options.title || utils.titleCase(repo);
+
         return generate.folder(
             dir,
             outputDir,
             {
-                title: options.title || utils.titleCase(repo),
+                title: title,
                 description: options.intro,
-                github: options.github || repoID
+                github: githubID
             }
         );
     })
     .then(function(output) {
         console.log("Successfuly built !");
     }, function(err) {
-        console.log(err.stack || err);
         throw err;
     })
     .then(_.constant(outputDir));

lib/generate/template.js

@@ -38,7 +38,10 @@ var initTemplate = function(options) {
 
         // Parse sections
         .then(function(markdown) {
-            return parse.page(markdown);
+            return parse.page(markdown, {
+                repo: options.locals.githubId,
+                dir: path.dirname(_input) || '/'
+            });
         })
 
         //Calcul template
@@ -49,7 +52,6 @@ var initTemplate = function(options) {
                     content: sections,
                     basePath: basePath,
                     staticBase: path.join(basePath, "gitbook"),
-                    navigation: options.locals.allNavigation[_output],
                     progress: parse.progress(options.locals.allNavigation, _output)
                 })
             );

lib/parse/navigation.js

@@ -45,6 +45,7 @@ function navigation(summary, files) {
 
         // Add chapter mapping
         mapping[chapter.path] = {
+            title: chapter.title,
             prev: clean(prev),
             next: clean(next),
             level: (idx+1).toString(),
@@ -59,6 +60,7 @@ function navigation(summary, files) {
             var next = (_idx+1 >= articles.length) ? nextChapter : clean(articles[_idx+1]);
 
             mapping[article.path] = {
+                title: article.title,
                 prev: clean(prev),
                 next: clean(next),
                 level: [idx+1, _idx+1].join('.'),
@@ -68,6 +70,7 @@ function navigation(summary, files) {
 
     // Hack for README.html
     mapping['README.html'] = {
+        title: README_NAV.title,
         prev: null,
         next: clean(summary.chapters[0]),
         level: '0',

lib/parse/page.js

@@ -46,19 +46,22 @@ function sectionType(nodes, idx) {
 }
 
 // Render a section using our custom renderer
-function render(section) {
+function render(section, _options) {
     // marked's Render expects this, we don't use it yet
     section.links = {};
 
     // Build options using defaults and our custom renderer
     var options = _.extend({}, marked.defaults, {
-        renderer: renderer()
+        renderer: renderer(null, _options)
     });
 
     return marked.parser(section, options);
 }
 
-function parsePage(src) {
+function parsePage(src, options) {
+    options = options || {};
+
+    // Lex file
     var nodes = marked.lexer(src);
 
     return _.chain(splitSections(nodes))
@@ -70,6 +73,19 @@ function parsePage(src) {
     .filter(function(section) {
         return !_.isEmpty(section);
     })
+    .reduce(function(sections, section) {
+        var last = _.last(sections);
+
+        // Merge normal sections together
+        if(last && last.type === section.type && last.type === 'normal') {
+            last.push.apply(last, [{'type': 'hr'}].concat(section));
+        } else {
+            // Add to list of sections
+            sections.push(section);
+        }
+
+        return sections;
+    }, [])
     .map(function(section) {
         // Generate a uniqueId to identify this section in our code
         var id = _.uniqueId('gitbook_');
@@ -100,7 +116,7 @@ function parsePage(src) {
         return {
             id: id,
             type: section.type,
-            content: render(section)
+            content: render(section, options)
         };
     })
     .value();

lib/parse/progress.js

@@ -2,7 +2,7 @@ var _ = require("lodash");
 
 var calculProgress = function(navigation, current) {
     var n = _.size(navigation);
-    var percent = 0, prevPercent = 0;
+    var percent = 0, prevPercent = 0, currentChapter = null;
     var done = true;
 
     var chapters = _.chain(navigation)
@@ -20,6 +20,7 @@ var calculProgress = function(navigation, current) {
         // Is it done
         nav.done = done;
         if (nav.path == current) {
+            currentChapter = nav;
             percent = nav.percent;
             done = false;
         } else if (done) {
@@ -30,11 +31,18 @@ var calculProgress = function(navigation, current) {
     })
     .value();
 
-
     return {
+        // Previous percent
         prevPercent: prevPercent,
+
+        // Current percent
         percent: percent,
-        chapters: chapters
+
+        // List of chapter with progress
+        chapters: chapters,
+
+        // Current chapter
+        current: currentChapter
     };
 }
 

lib/parse/renderer.js

@@ -1,14 +1,18 @@
 var url = require('url');
 var inherits = require('util').inherits;
 
+var path = require('path');
+
 var marked = require('marked');
 
 
-function GitBookRenderer(options) {
+function GitBookRenderer(options, extra_options) {
     if(!(this instanceof GitBookRenderer)) {
-        return new GitBookRenderer(options);
+        return new GitBookRenderer(options, extra_options);
     }
     GitBookRenderer.super_.call(this, options);
+
+    this._extra_options = extra_options;
 }
 inherits(GitBookRenderer, marked.Renderer);
 
@@ -39,6 +43,16 @@ GitBookRenderer.prototype.link = function(href, title, text) {
     // Parsed version of the url
     var parsed = url.parse(href);
 
+    var o = this._extra_options;
+    // Relative link, rewrite it to point to github repo
+    if(parsed.path[0] != '/' && o && o.repo && o.dir) {
+        href = 'https://github.com/' + o.repo + '/blob' + path.normalize(path.join(
+            '/',
+            o.dir,
+            href
+        ));
+        parsed = url.parse(href);
+    }
 
     // Generate HTML for link
     var out = '<a href="' + href + '"';

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.0.3",
+    "version": "0.1.0",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
     "dependencies": {

templates/includes/book/header.html

@@ -1,9 +1,13 @@
 <div class="book-header">
     <!-- Actions Left -->
     <a href="https://github.com/{{ githubId }}" target="_blank" class="btn pull-left"><i class="fa fa-github-alt"></i></a>
-    <a href="#" class="btn pull-left toggle-summary"><i class="fa fa-align-justify"></i> Summary</a>
+    <a href="#" class="btn pull-left toggle-summary"><i class="fa fa-align-justify"></i></a>
 
     <!-- Actions Right -->
+    <a href="#" target="_blank" class="btn pull-right" data-sharing="google-plus"><i class="fa fa-google-plus"></i></a>
+    <a href="#" target="_blank" class="btn pull-right" data-sharing="facebook"><i class="fa fa-facebook"></i></a>
+    <a href="#" target="_blank" class="btn pull-right" data-sharing="twitter"><i class="fa fa-twitter"></i></a>
+
     <a href="https://github.com/{{ githubId }}/stargazers" target="_blank" class="btn pull-right count-star"><i class="fa fa-star-o"></i> Star (<span>-</span>)</a>
     <a href="https://github.com/{{ githubId }}/watchers" target="_blank" class="btn pull-right count-watch"><i class="fa fa-eye"></i> Watch (<span>-</span>)</a>
 

templates/includes/book/summary.html

@@ -6,6 +6,9 @@
         <li>
             <a href="https://github.com/{{ githubId }}/issues" target="blank">Questions and Issues</a>
         </li>
+        <li>
+            <a href="https://github.com/{{ githubId }}/edit/master/{{ _input }}" target="blank">Edit and Contribute</a>
+        </li>
         <li class="divider"></li>
         <li data-level="0">
             <a href="{{ basePath }}/README.html"><i class="fa fa-check"></i> Introduction</a>

templates/layout.html

@@ -1,18 +1,39 @@
 <!DOCTYPE HTML>
 <html lang="en-US">
-    <head>
+    <head prefix="og: http://ogp.me/ns# book: http://ogp.me/ns/book#">
         {% block head %}
         <meta charset="UTF-8">
-        <title>{% block title %} | GitBook{% endblock %}</title>
-        <meta name="robots" content="{% block robots %}noindex, nofollow{% endblock %}">
-        <link rel="shortcut icon" href="{{ staticBase }}/images/favicon.ico" type="image/x-icon">
-        <link rel="stylesheet" href="{{ staticBase }}/style.css">
+        <title>{% block title %} | {{ 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 }}" />
+        {% endif %}
+        {% if progress.current.prev and progress.current.prev.path %}
+        <link rel="prev" href="{{ basePath }}/{{ progress.current.prev.path }}" />
+        {% 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="https://github.com/{{ githubAuthor }}">
+        <meta property="book:tag" content="GitBook">
+        
         <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">
+        <link rel="stylesheet" href="{{ staticBase }}/style.css">
+
         <script type="text/javascript">
         (function(e,b){if(!b.__SV){var a,f,i,g;window.mixpanel=b;b._i=[];b.init=function(a,e,d){function f(b,h){var a=h.split(".");2==a.length&&(b=b[a[0]],h=a[1]);b[h]=function(){b.push([h].concat(Array.prototype.slice.call(arguments,0)))}}var c=b;"undefined"!==typeof d?c=b[d]=[]:d="mixpanel";c.people=c.people||[];c.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};c.people.toString=function(){return c.toString(1)+".people (stub)"};i="disable track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config people.set people.set_once people.increment people.append people.track_charge people.clear_charges people.delete_user".split(" ");
         for(g=0;g<i.length;g++)f(c,i[g]);b._i.push([a,e,d])};b.__SV=1.2;a=e.createElement("script");a.type="text/javascript";a.src=("https:"===e.location.protocol?"https:":"http:")+'//cdn.mxpnl.com/libs/mixpanel-2.2.min.js';f=e.getElementsByTagName("script")[0];f.parentNode.insertBefore(a,f)}})(document,window.mixpanel||[]);

templates/page.html

@@ -1,13 +1,11 @@
 {% extends "layout.html" %}
 
-{% block title %}{{ _input }} {{ title }}{% parent %}{% endblock %}
-{% block description %}{% endblock %}
-{% block robots %}index, follow{% endblock %}
+{% block title %}{{ progress.current.title }}{% parent %}{% endblock %}
 {% block content %}
-<div class="book {% if _input == "README.md" %}with-summary{% endif %}" data-github="{{ githubId }}" data-level="{{ navigation.level }}">
+<div class="book with-summary" data-github="{{ githubId }}" data-level="{{ progress.current.level }}">
     {% include "includes/book/header.html" %}
     {% include "includes/book/summary.html" %}
-    <div class="book-body">
+    <div class="book-body" tabindex="-1">
         <div class="page-wrapper">
             <div class="book-progress">
                 <div class="bar">
@@ -34,11 +32,11 @@
 
             <div class="page-footer">
                 {% if _input == "README.md" %}
-                    <a href="{{ basePath }}/{{ navigation.next.path }}" class="navigation-link">Start</a>
+                    <a href="{{ basePath }}/{{ progress.current.next.path }}" class="navigation-link">Start</a>
                 {% else %}
-                    {% if navigation.next %}
-                        {% if navigation.next.path %}
-                        <a href="{{ basePath }}/{{ navigation.next.path }}" class="navigation-link next">Next</a>
+                    {% if progress.current.next %}
+                        {% if progress.current.next.path %}
+                        <a href="{{ basePath }}/{{ progress.current.next.path }}" class="navigation-link next">Next</a>
                         {% else %}
                         <div class="navigation-link coming-soon">Coming soon</div>
                         {% endif %}

test/fixtures/GITHUB_LINKS.md

@@ -0,0 +1,3 @@
+# Nice course
+
+Check out this source file [in C++](../src/something.cpp)

test/fixtures/HR_PAGE.md

@@ -0,0 +1,11 @@
+## Wow such book
+
+Some nice content here
+
+---
+
+A beautiful separator, but non an exercise !
+
+---
+
+Some more beautiful text, because `this` book is awesome ...

test/page.js

@@ -8,6 +8,12 @@ var page = require('../').parse.page;
 var CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/PAGE.md'), 'utf8');
 var LEXED = page(CONTENT);
 
+var HR_CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/HR_PAGE.md'), 'utf8');
+var HR_LEXED = page(HR_CONTENT);
+
+var LINKS_CONTENT = fs.readFileSync(path.join(__dirname, './fixtures/GITHUB_LINKS.md'), 'utf8');
+
+
 describe('Page parsing', function() {
     it('should detection sections', function() {
         assert.equal(LEXED.length, 3);
@@ -31,4 +37,27 @@ describe('Page parsing', function() {
         assert(LEXED[1].code.solution);
         assert(LEXED[1].code.validation);
     });
+
+    it('should merge sections correctly', function() {
+        // One big section
+        assert.equal(HR_LEXED.length, 1);
+
+        // HRs inserted correctly
+        assert.equal(HR_LEXED[0].content.match(/<hr>/g).length, 2);
+    });
+});
+
+
+describe('Relative links', function() {
+    it('should be resolved to their GitHub counterparts', function() {
+        var LEXED = page(LINKS_CONTENT, {
+            // GitHub repo ID
+            repo: 'GitBookIO/javascript',
+
+            // Imaginary folder of markdown file
+            dir: 'course',
+        });
+
+        assert(LEXED[0].content.indexOf('https://github.com/GitBookIO/javascript/blob/src/something.cpp') !== -1);
+    });
 });