Add changelog for 1.1.0

Apply plugins to ebook generation

CHANGES.md

@@ -1,5 +1,13 @@
 # Release notes
 
+## 1.1.0
+- Plugins can now extend the ebook generation (pdf, epub, mobi)
+- Update `kramed` to version 0.4.3
+
+## 1.0.3
+- Update `mathjax` plugin and MathJAx to version 2.4
+- Update `highlight.js` to 8.2.0
+
 ## 1.0.2
 - Update `mathjax` plugin, fixes issues with inline math rendering (no longer wanted)
 

lib/generate/generator.js

@@ -8,6 +8,9 @@ var Plugin = require("./plugin");
 var BaseGenerator = function(options) {
     this.options = options;
 
+    // Base for assets in plugins
+    this.pluginAssetsBase = "book";
+
     this.options.plugins = Plugin.normalizeNames(this.options.plugins);
     this.options.plugins = _.union(this.options.plugins, this.options.defaultsPlugins);
     this.plugins = [];
@@ -20,7 +23,9 @@ BaseGenerator.prototype.callHook = function(name, data) {
 BaseGenerator.prototype.loadPlugins = function() {
     var that = this;
 
-    return Plugin.fromList(this.options.plugins, this.options.input, this)
+    return Plugin.fromList(this.options.plugins, this.options.input, this, {
+        assetsBase: this.pluginAssetsBase
+    })
     .then(function(_plugins) {
         that.plugins = _plugins;
 

lib/generate/json/index.js

@@ -26,7 +26,6 @@ Generator.prototype.convertFile = function(content, input) {
     return Q()
     .then(function() {
         return parse.page(content, {
-            repo: that.options.githubId,
             dir: path.dirname(input) || '/'
         });
     })

lib/generate/page/index.js

@@ -15,6 +15,9 @@ var BaseGenerator = require("../site");
 var Generator = function() {
     BaseGenerator.apply(this, arguments);
 
+    // Base for assets in plugins
+    this.pluginAssetsBase = "ebook";
+
     // List of pages content
     this.pages = {};
 };
@@ -34,20 +37,9 @@ Generator.prototype.convertFile = function(content, input) {
         progress: parse.progress(this.options.navigation, input)
     };
 
-    return Q()
-    .then(function() {
-        return parse.page(content, {
-            repo: that.options.githubId,
-            dir: path.dirname(input) || '/',
-            outdir: './',
-            singleFile: true
-        });
-    })
-    .then(function(sections) {
-        json.content = sections;
-    })
-    .then(function() {
-        that.pages[input] = json;
+    return this.prepareFile(content, input)
+    .then(function(page) {
+        that.pages[input] = page;
     });
 };
 
@@ -82,10 +74,7 @@ Generator.prototype.finish = function() {
 
     // Copy assets
     .then(function() {
-        return fs.copy(
-            path.join(that.options.theme, "assets"),
-            path.join(that.options.output, "gitbook")
-        );
+        return that.copyAssets();
     });
 };
 

lib/generate/plugin.js

@@ -65,8 +65,9 @@ Plugin.prototype.normalizeResource = function(resource) {
 };
 
 // Return resources
-Plugin.prototype._getResources = function() {
-    var book = this.infos.book;
+Plugin.prototype._getResources = function(base) {
+    base = base || "book";
+    var book = this.infos[base];
 
     // Nothing specified, fallback to default
     if (!book) {
@@ -84,12 +85,10 @@ Plugin.prototype._getResources = function() {
 };
 
 // Normalize resources and return them
-Plugin.prototype.getResources = function() {
+Plugin.prototype.getResources = function(base) {
     var that = this;
 
-
-
-    return this._getResources()
+    return this._getResources(base)
     .then(function(resources) {
 
         _.each(RESOURCES, function(resourceType) {
@@ -133,10 +132,14 @@ Plugin.prototype.callHook = function(name, data) {
 };
 
 // Copy plugin assets fodler
-Plugin.prototype.copyAssets = function(out) {
+Plugin.prototype.copyAssets = function(out, options) {
     var that = this;
+    options = _.defaults(options || {}, {
+        base: "book"
+    });
 
-    return this.getResources().get('assets')
+    return this.getResources(options.base)
+    .get('assets')
     .then(function(assets) {
         // Assets are undefined
         if(!assets) return false;
@@ -149,8 +152,6 @@ Plugin.prototype.copyAssets = function(out) {
 };
 
 
-
-
 // Normalize a list of plugin name to use
 Plugin.normalizeNames = function(names) {
     // Normalize list to an array
@@ -181,7 +182,11 @@ Plugin.normalizeNames = function(names) {
 };
 
 // Extract data from a list of plugin
-Plugin.fromList = function(names, root, generator) {
+Plugin.fromList = function(names, root, generator, options) {
+    options = _.defaults(options || {}, {
+        assetsBase: "book"
+    });
+
     var failed = [];
 
     // Load plugins
@@ -198,7 +203,7 @@ Plugin.fromList = function(names, root, generator) {
 
     // Get resources of plugins
     return Q.all(_.map(plugins, function(plugin) {
-        return plugin.getResources();
+        return plugin.getResources(options.assetsBase);
     }))
     // Extract resources out
     // css, js, etc ...

lib/generate/site/index.js

@@ -59,10 +59,6 @@ Generator.prototype._writeTemplate = function(tpl, options, output, interpolate)
             title: that.options.title,
             description: that.options.description,
 
-            githubAuthor: that.options.github ? that.options.github.split("/")[0] : "",
-            githubId: that.options.github,
-            githubHost: that.options.githubHost,
-
             glossary: that.options.glossary,
 
             summary: that.options.summary,
@@ -95,20 +91,15 @@ Generator.prototype.indexPage = function(lexed, pagePath) {
     return Q();
 };
 
-// Convert a markdown file to html
-Generator.prototype.convertFile = function(content, _input) {
+// Convert a markdown file into a normalized data set
+Generator.prototype.prepareFile  = function(content, _input) {
     var that = this;
 
-    _output = _input.replace(".md", ".html");
-    if (_output == "README.html") _output = "index.html";
-
     var input = path.join(this.options.input, _input);
-    var output = path.join(this.options.output, _output);
-    var basePath = path.relative(path.dirname(output), this.options.output) || ".";
 
     var page = {
         path: _input,
-	rawPath: input, // path to raw md file
+        rawPath: input,
         content: content,
         progress: parse.progress(this.options.navigation, _input)
     };
@@ -131,14 +122,10 @@ Generator.prototype.convertFile = function(content, _input) {
         return parse.lex(page.content);
     })
     .then(function(lexed) {
-        // Index page in search
-        return that.indexPage(lexed, _output)
-        .then(_.constant(lexed));
-    })
-    .then(function(lexed) {
+        page.lexed = lexed;
+
         // Get HTML generated sections
         return parse.page(lexed, {
-            repo: that.options.githubId,
             dir: path.dirname(_input) || '/',
             outdir: path.dirname(_input) || '/',
         });
@@ -150,10 +137,30 @@ Generator.prototype.convertFile = function(content, _input) {
         return _callHook("page");
     })
     .then(function() {
+        return page;
+    });
+};
+
+// Convert a markdown file to html
+Generator.prototype.convertFile = function(content, _input) {
+    var that = this;
+
+    var _output = _input.replace(".md", ".html");
+    if (_output == "README.html") _output = "index.html";
+    var output = path.join(this.options.output, _output);
+    var basePath = path.relative(path.dirname(output), this.options.output) || ".";
+
+    return this.prepareFile(content, _input)
+    .then(function(page) {
+        // Index page in search
+        return that.indexPage(page.lexed, _output).thenResolve(page);
+    })
+    .then(function(page) {
+        // Write file
         return that._writeTemplate(that.template, {
             progress: page.progress,
 
-            _input: _input,
+            _input: page.path,
             content: page.sections,
 
             basePath: basePath,
@@ -161,7 +168,7 @@ Generator.prototype.convertFile = function(content, _input) {
         }, output, function(html) {
             page.content = html;
 
-            return _callHook("page:after").get("content")
+            return that.callHook("page:after", page).get("content")
         });
     });
 };
@@ -238,7 +245,9 @@ Generator.prototype.copyAssets = function() {
         return Q.all(
             _.map(that.plugins.list, function(plugin) {
                 var pluginAssets = path.join(that.options.output, "gitbook/plugins/", plugin.name);
-                return plugin.copyAssets(pluginAssets);
+                return plugin.copyAssets(pluginAssets, {
+                    base: that.pluginAssetsBase
+                });
             })
         );
     });

lib/parse/renderer.js

@@ -118,8 +118,10 @@ GitBookRenderer.prototype._createCheckboxAndRadios = function(text) {
     if (!match) {
         return text;
     }
-    var quizIdentifier = 'quiz-row-' + this.id + '-' + this.quizRowId + '-' + this.quizIndex++;
-    var field = "<input name='" + quizIdentifier + "' id='" + quizIdentifier + "' type='";
+    //fix radio input uncheck failed
+    var quizFieldName='quiz-row-' + this.id + '-' + this.quizRowId ;
+    var quizIdentifier = quizFieldName + '-' + this.quizIndex++;
+    var field = "<input name='" + quizFieldName + "' id='" + quizIdentifier + "' type='";
     field += match[1] === '(' ? "radio" : "checkbox";
     field += match[2] === 'x' ? "' checked/>" : "'/>";
     var splittedText = text.split(fieldRegex);

package.json

@@ -1,13 +1,13 @@
 {
     "name": "gitbook",
-    "version": "1.0.2",
+    "version": "1.1.0",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
     "dependencies": {
         "q": "1.0.1",
         "lodash": "2.4.1",
-        "kramed": "0.4.2",
+        "kramed": "0.4.3",
         "kramed-text-renderer": "0.2.1",
         "lunr": "0.5.2",
         "swig": "1.3.2",
@@ -16,14 +16,14 @@
         "commander": "2.2.0",
         "graceful-fs": "3.0.2",
         "fs-extra": "0.10.0",
-        "highlight.js": "8.1.0",
+        "highlight.js": "8.2.0",
         "tmp": "0.0.23",
         "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-mathjax": "0.0.5",
+        "gitbook-plugin-mathjax": "0.0.6",
         "gitbook-plugin-livereload": "0.0.1",
         "gitbook-plugin-exercises": "1.0.0",
         "gitbook-plugin-quizzes": "1.0.0"

theme/javascript/core/state.js

@@ -7,7 +7,6 @@ define([
         var $book = $(dom.find(".book"));
 
         state.$book = $book;
-        state.githubId = $book.data("github");
         state.level = $book.data("level");
         state.basePath = $book.data("basepath");
         state.revision = $book.data("revision");

theme/javascript/gitbook.js

@@ -18,11 +18,6 @@ define([
         var $book;
         $book = state.$book;
 
-        if (state.githubId) {
-            // Initialize storage
-            storage.setBaseKey(state.githubId);
-        }
-
         // Init sidebar
         sidebar.init();
 

theme/templates/page.html

@@ -4,6 +4,13 @@
 
 {% block style %}
 <link rel="stylesheet" href="{{ staticBase }}/print.css">
+{% for resource in plugins.resources.css %}
+    {% if resource.url %}
+    <link rel="stylesheet" href="{{ resource.url }}">
+    {% else %}
+    <link rel="stylesheet" href="{{ staticBase }}/plugins/{{ resource.path }}">
+    {% endif %}
+{% endfor %}
 {% endblock %}
 
 
@@ -41,7 +48,7 @@
     <article id="{{ article.path }}">
         <h1 class="book-chapter book-chapter-{{ item.level|lvl }}">{{ item.title }}</h1>
         {% if pages[item.path] %}
-        {{ articleContent(pages[item.path].content) }}
+        {{ articleContent(pages[item.path].sections) }}
         {% endif %}
     </article>
     {% endfor %}
@@ -56,7 +63,7 @@
 
             {% for item in progress.chapters %}
                 {% if pages[item.path] %}
-                    {% for section in pages[item.path].content %}
+                    {% for section in pages[item.path].sections %}
                         {% if section.type == "exercise" %}
                             <div class="exercise">
                                 <div class="exercise-header">Exercise #{{ exercise }}</div>

theme/templates/site.html

@@ -17,7 +17,7 @@
 {% 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 }}">
+    <div class="book" data-level="{{ progress.current.level }}" data-basepath="{{ basePath }}" data-revision="{{ revision }}">
     {% include "includes/book/summary.html" %}
     <div class="book-body">
         <div class="body-inner">