Bump version to 0.6.1

Update summary.html (fixed an HTML typo)

CHANGES.md

@@ -1,2 +1,7 @@
 # Release notes
 
+## 0.6.0
+- Generate header id the same as github
+- Custom links can be added at top of sidebar
+- Summary can now be transformed by plugins
+- Support importing code snippets

README.md

@@ -92,6 +92,11 @@ Here are the options that can be stored in this file:
         "issues": null,
         "contribute": null,
 
+    	// Custom links at top of sidebar
+    	"custom": {
+    	    "Custom link name": "https://customlink.com"
+    	},
+
         // Sharing links
         "sharing": {
             "google": null,
@@ -253,6 +258,8 @@ Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](ht
 * [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages
 * [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook
 * [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik): Piwik Open Analytics tracking for your book
+* [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors): Add linkable Github-style anchors to headings
+* [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin): Ebedded jsbin frame into your book
 
 #### Debugging
 

bin/gitbook.js

@@ -14,6 +14,7 @@ var fs = require('../lib/generate/fs');
 var utils = require('./utils');
 var build = require('./build');
 var Server = require('./server');
+var platform = require("./platform");
 
 // General options
 prog
@@ -115,6 +116,22 @@ prog
     return initDir(dir);
 });
 
+prog
+.command('publish [source_dir]')
+.description('Publish content to the associated gitbook.io book')
+.action(function(dir) {
+    dir = dir || process.cwd();
+    return platform.publish(dir);
+});
+
+prog
+.command('git:remote [source_dir] [book_id]')
+.description('Adds a git remote to a book repository')
+.action(function(dir, bookId) {
+    dir = dir || process.cwd();
+    return platform.remote(dir, bookId);
+});
+
 // Parse and fallback to help if no args
 if(_.isEmpty(prog.parse(process.argv).args) && process.argv.length === 2) {
     prog.help();

bin/platform.js

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

bin/utils.js

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

lib/generate/fs.js

@@ -30,6 +30,11 @@ var getFiles = function(path) {
         '*.pdf',
         '*.epub',
         '*.mobi',
+
+        // Skip config files
+        '.ignore',
+        '.bookignore',
+        'book.json',
     ], '__custom_stuff');
 
     // Push each file to our list

lib/generate/index.js

@@ -271,13 +271,31 @@ var generateBook = function(options) {
 
         // Get summary
         .then(function() {
-            return fs.readFile(path.join(options.input, "SUMMARY.md"), "utf-8")
-            .then(function(_summary) {
-                options.summary = parse.summary(_summary);
+            var summary = {
+                path: path.join(options.input, "SUMMARY.md")
+            };
 
-                // Parse navigation
-                options.navigation = parse.navigation(options.summary);
-            });
+            var _callHook = function(name) {
+                return generator.callHook(name, summary)
+                .then(function(_summary) {
+                    summary = _summary;
+                    return summary;
+                });
+            };
+
+            return fs.readFile(summary.path, "utf-8")
+                .then(function(_content) {
+                    summary.content = _content;
+                    return _callHook("summary:before");
+                })
+                .then(function() {
+                    summary.content = parse.summary(summary.content);
+                    return _callHook("summary:after");
+                })
+                .then(function() {
+                    options.summary = summary.content;
+                    options.navigation = parse.navigation(options.summary);
+                })
         })
 
         // Skip processing some files

lib/generate/site/index.js

@@ -102,6 +102,7 @@ Generator.prototype.convertFile = function(content, _input) {
 
     var page = {
         path: _input,
+	rawPath: input, // path to raw md file
         content: content,
         progress: parse.progress(this.options.navigation, _input)
     };

lib/parse/code_include.js

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

lib/parse/lex.js

@@ -118,6 +118,10 @@ function lexPage(src) {
 
         return sections;
     }, [])
+    .map(function(section) {
+        section.links = nodes.links;
+        return section;
+    })
     .value();
 }
 

lib/parse/page.js

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

lib/parse/renderer.js

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

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.5.6",
+    "version": "0.6.1",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -22,7 +22,7 @@
         "resolve": "0.6.3",
         "tiny-lr-fork": "0.0.5",
         "gitbook-plugin": "0.0.2",
-        "gitbook-plugin-mathjax": "0.0.3",
+        "gitbook-plugin-mathjax": "0.0.4",
         "gitbook-plugin-livereload": "0.0.1"
     },
     "devDependencies": {

test/fixtures/INCLUDES.md

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

test/fixtures/included.c

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

test/includes.js

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

theme/javascript/core/exercise.js

@@ -18,6 +18,14 @@ define([
         editor.setTheme("ace/theme/tomorrow");
         editor.getSession().setUseWorker(false);
         editor.getSession().setMode("ace/mode/javascript");
+        
+        editor.commands.addCommand({
+            name: "submit",
+            bindKey: "Ctrl-Return|Cmd-Return",
+            exec: function() {
+                $exercise.find(".action-submit").click();
+            }
+        });
 
         // Submit: test code
         $exercise.find(".action-submit").click(function(e) {
@@ -52,4 +60,4 @@ define([
         init: init,
         prepare: prepareExercise
     };
-});
+});

theme/templates/includes/book/summary.html

@@ -1,7 +1,7 @@
 {% macro articles(_articles) %}
     {% for item in _articles %}
         {% 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 %}>
+        <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 %}
                 {% if !externalLink %}
                     <a href="{{ basePath }}/{{ item.path|mdLink }}">
@@ -48,7 +48,7 @@
         {% if options.links.issues !== false && (options.links.issues || githubId) %}
         {% set _divider = true %}
         <li>
-            <a href="{{ options.links.issues|default(githubHost+githubId+"/issues") }}" target="blank"class="issues-link">Questions and Issues</a>
+            <a href="{{ options.links.issues|default(githubHost+githubId+"/issues") }}" target="blank" class="issues-link">Questions and Issues</a>
         </li>
         {% endif %}
 
@@ -59,6 +59,15 @@
         </li>
         {% endif %}
 
+	{% if options.links.custom %}
+	{% for link in options.links.custom %}
+	    {% set _divider = true %}
+	     <li> 
+	         <a href="{{ options.links.custom[loop.key] }}" target="blank" class="custom-link">{{ loop.key }}</a>
+             </li>
+	{% endfor %}
+	{% endif %}
+
         {% if _divider %}
         <li class="divider"></li>
         {% endif %}