Bump version to 0.5.3

Gruntfile.js

@@ -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)
 

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

@@ -61,6 +61,7 @@ Generator.prototype.finish = function() {
                 "--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)
             });

lib/generate/fs.js

@@ -16,9 +16,20 @@ 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',
     ], '__custom_stuff');
 
     // Push each file to our list

lib/generate/generator.js

@@ -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");
@@ -161,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());
@@ -176,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));
 };

lib/generate/page/index.js

@@ -2,32 +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;
-});
-
-// Join path
-swig.setFilter('pathJoin', function(base, _path) {
-    return path.join(base, _path);
-});
-
 
 /*
  *  This generator will generate a simple index.html which can be converted as a PDF
@@ -95,6 +75,11 @@ Generator.prototype.finish = function() {
         }, output);
     })
 
+    // Copy cover
+    .then(function() {
+        return that.copyCover();
+    })
+
     // Copy assets
     .then(function() {
         return fs.copy(

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);
@@ -162,7 +152,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 +188,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");
     })
@@ -237,7 +227,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/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/utils/links.js

@@ -1,6 +1,11 @@
 var url = require('url');
 var path = require('path');
 
+// Is the link an external link
+var isExternal = function(href) {
+    return Boolean(url.parse(href).protocol);
+};
+
 // Return true if the link is relative
 var isRelative = function(href) {
     var parsed = url.parse(href);
@@ -26,8 +31,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
+};

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.5.0",
+    "version": "0.5.3",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",

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();

theme/javascript/core/font-settings.js

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

theme/stylesheets/ebook.less

@@ -1,4 +1,3 @@
-@import "vendors/bootstrap/bootstrap.less";
 @import "mixins.less";
 
 @import "ebook/variables.less";
@@ -12,16 +11,11 @@ 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;
+    background: #f1f1f1;
+    padding: 8px;
 }
 
 img {
@@ -30,7 +24,7 @@ img {
     margin: 0px auto;
 }
 
-.exercise {
+.exercise, .quiz {
     margin: 1cm 0cm;
     padding: 0.4cm;
     page-break-inside: avoid;
@@ -42,4 +36,8 @@ img {
         padding-bottom: 0.2cm;
         border-bottom: 1px solid #ddd;
     }
+
+    .question {
+        margin-top: 0.4cm;
+    }
 }

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 {

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 {

theme/stylesheets/website/variables.less

@@ -43,6 +43,9 @@
 @page-color:                          black;
 @page-background:                     @body-background;
 
+// Content
+@content-line-height:                 1.6em;
+
 // Progress Bar
 @chapter-display:                     none;
 @chapter-size:                        16px;
@@ -86,11 +89,12 @@
 @FontPath:                            '@{staticPath}/fonts';
 @fa-font-path:                        "@{FontPath}/fontawesome";
 
-@s-font-size:                                                   1.2rem;
-@m-font-size:                                                   1.4rem;
-@l-font-size:                                                   1.6rem;
+@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;
 
 /*
 ,--------.,--.

theme/templates/includes/book/summary.html

@@ -1,10 +1,17 @@
 {% 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> <b>{{ item.level }}.</b> {{ item.title }}
+                    </a>
+                {% else %}
+                    <a target="_blank" href="{{ item.path }}">
+                        <i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
+                    </a>
+                {% endif %}
             {% else %}
             <span><b>{{ item.level }}.</b> {{ item.title }}</span>
             {% endif %}

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">

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 %}
@@ -60,9 +65,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 }}">