Bump version to 3.0.0-pre.8

Fix minor spelling error.

docs/pages.md

@@ -25,7 +25,7 @@ Each chapter has a dedicated page (`part#/README.md`) and is split into subchapt
 
 ##### Anchors
 
-Chaptersi n the Table of Contents can be pointing to specific part of a file using anchor.
+Chapters in the Table of Contents can be pointing to specific part of a file using anchor.
 
 ```markdown
 # Summary

lib/cli/watch.js

@@ -11,7 +11,7 @@ function watch(dir) {
     dir = path.resolve(dir);
 
     var toWatch = [
-        'book.json', 'book.js'
+        'book.json', 'book.js', '_layouts/**'
     ];
 
     // Watch all parsable files

lib/config/plugins.js

@@ -1,7 +1,7 @@
 var _ = require('lodash');
 
 // Default plugins added to each books
-var DEFAULT_PLUGINS = ['highlight', 'search', 'sharing', 'fontsettings', 'theme-default'];
+var DEFAULT_PLUGINS = ['highlight', 'search', 'lunr', 'sharing', 'fontsettings', 'theme-default'];
 
 // Return true if a plugin is a default plugin
 function isDefaultPlugin(name, version) {

lib/output/base.js

@@ -38,10 +38,8 @@ function Output(book, opts, parent) {
     // Files to ignore in output
     this.ignore = Ignore();
 
-    // Hack to inherits from rules of the book:
-    // Waiting for https://github.com/kaelzhang/node-ignore/pull/19 to be merged
-    this.ignore._rules = this.ignore._rules.concat(this.book.ignore._rules);
-    this.ignore._cache = {};
+    // Hack to inherits from rules of the book
+    this.ignore.add(this.book.ignore);
 }
 
 // Default name for generator
@@ -209,6 +207,10 @@ Output.prototype.onOutputSVG = function(page, svg) {
 // Output an image as a file
 // Normalize the relative link
 Output.prototype.onOutputImage = function(page, imgFile) {
+    if (location.isExternal(imgFile)) {
+        return imgFile;
+    }
+
     imgFile = page.resolveLocal(imgFile);
     return page.relative(imgFile);
 };

lib/output/website.js

@@ -96,6 +96,14 @@ WebsiteOutput.prototype.prepare = function() {
             return that.toURL(s);
         });
 
+        // Get an article using its path
+        that.env.addFilter('getArticleByPath', function(s) {
+            var article = that.book.summary.getArticle(s);
+            if (!article) return undefined;
+
+            return article.getContext();
+        });
+
         // Relase path to an asset
         that.env.addFilter('resolveAsset', function(href) {
             href = path.join('gitbook', href);
@@ -208,11 +216,24 @@ WebsiteOutput.prototype.outputMultilingualIndex = function() {
 // Render a template using nunjucks
 // Templates are stored in `_layouts` folders
 WebsiteOutput.prototype.render = function(tpl, context) {
+    var that = this;
     var filename = this.templateName(tpl);
 
     context = _.extend(context, {
         template: {
-            self: filename
+            self: filename,
+            getJSContext: function() {
+                return {
+                    page: _.omit(context.page, 'content'),
+                    config: context.config,
+                    file: context.file,
+                    gitbook: context.gitbook,
+                    basePath: location.normalize(that.resolveForPage(context.file.path, './')),
+                    book: {
+                        language: context.book.language
+                    }
+                };
+            }
         },
 
         plugins: {

lib/page/html.js

@@ -184,8 +184,18 @@ HTMLPipeline.prototype.applyAnnotations = function() {
 // Extract page description from html
 // This can totally be improved
 HTMLPipeline.prototype.extractDescription = function() {
-    var $p = this.$('p').first();
-    var description = $p.text().trim().slice(0, 155);
+    var $ = this.$;
+    var $p = $('p').first();
+    var $next = $p.nextUntil('h1,h2,h3,h4,h5,h6,pre,blockquote,ul,ol,div');
+
+    var description = $p.text().trim();
+
+    $next.each(function() {
+        description += ' ' + $(this).text().trim();
+    });
+
+    // Truncate description
+    description = _.trunc(description, 300);
 
     this.opts.onDescription(description);
 };

lib/page/index.js

@@ -7,7 +7,6 @@ var error = require('../utils/error');
 var pathUtil = require('../utils/path');
 var location = require('../utils/location');
 var parsers = require('../parsers');
-var gitbook = require('../gitbook');
 var pluginCompatibility = require('../plugins/compatibility');
 var HTMLPipeline = require('./html');
 

lib/plugins/compatibility.js

@@ -14,12 +14,13 @@ function pluginCtx(plugin) {
 
 // Call a function "fn" with a context of page similar to the one in GitBook v2
 function pageHook(page, fn) {
-    var ctx = {
-        type: page.type,
-        content: page.content,
-        path: page.path,
-        rawPath: page.rawPath
-    };
+    // Get page context
+    var ctx = page.getContext().page;
+
+    // Add other informations
+    ctx.type    = page.type;
+    ctx.rawPath = page.rawPath;
+    ctx.path    = page.path;
 
     // Deprecate sections
     error.deprecateField(ctx, 'sections', [

lib/plugins/registry.js

@@ -144,10 +144,16 @@ function listInstalled(folder) {
 function listPlugins(book) {
     return Promise.all([
         listInstalled(path.resolve(__dirname, '../..')),
-        listInstalled(book.root)
+        listInstalled(book.root),
+        book.isLanguageBook()? listInstalled(book.parent.root) : Promise([])
     ])
-    .spread(function(defaultPlugins, plugins) {
-        var results = plugins.concat(defaultPlugins);
+    .spread(function() {
+        var args = _.toArray(arguments);
+
+        var results = _.reduce(args, function(out, a) {
+            return out.concat(a);
+        }, []);
+
         return _.uniq(results, 'name');
     });
 }

lib/template/index.js

@@ -10,6 +10,8 @@ var defaultBlocks = require('./blocks');
 var defaultFilters = require('./filters');
 var Loader = require('./loader');
 
+var NODE_ENDARGS = '%%endargs%%';
+
 // Return extension name for a specific block
 function blockExtName(name) {
     return 'Block'+name+'Extension';
@@ -21,6 +23,12 @@ function normBlockResult(blk) {
     return blk;
 }
 
+// Extract kwargs from an arguments array
+function extractKwargs(args) {
+    var last = _.last(args);
+    return (_.isObject(last) && last.__keywords)? args.pop() : {};
+}
+
 function TemplateEngine(output) {
     this.output = output;
     this.book = output.book;
@@ -63,6 +71,14 @@ function TemplateEngine(output) {
     // Add default blocks and filters
     this.addBlocks(defaultBlocks);
     this.addFilters(defaultFilters);
+
+    // Build context for this book with depreacted fields
+    this.ctx = {
+        template: this,
+        book: this.book,
+        output: this.output
+    };
+    error.deprecateField(this.ctx, 'generator', this.output.name, '"generator" property is deprecated, use "output.generator" instead');
 }
 
 // Bind a function to a context
@@ -71,12 +87,9 @@ TemplateEngine.prototype.bindContext = function(func) {
     var that = this;
 
     return function() {
-        var ctx = {
-            ctx: this.ctx,
-            book: that.book,
-            output: that.output
-        };
-        error.deprecateField(ctx, 'generator', that.output.name, '"generator" property is deprecated, use "output.generator" instead');
+        var ctx = _.extend({
+            ctx: this.ctx
+        }, that.ctx);
 
         return func.apply(ctx, arguments);
     };
@@ -174,91 +187,100 @@ TemplateEngine.prototype.addBlock = function(name, block) {
         this.tags = [name];
 
         this.parse = function(parser, nodes) {
-            var body = null;
             var lastBlockName = null;
             var lastBlockArgs = null;
             var allBlocks = block.blocks.concat([block.end]);
-            var subbodies = {};
 
+            // Parse first block
             var tok = parser.nextToken();
-            var args = parser.parseSignature(null, true);
+            lastBlockArgs = parser.parseSignature(null, true);
             parser.advanceAfterBlockEnd(tok.value);
 
+            var args = new nodes.NodeList();
+            var bodies = [];
+            var blockNamesNode = new nodes.Array(tok.lineno, tok.colno);
+            var blockArgCounts = new nodes.Array(tok.lineno, tok.colno);
+
+            // Parse while we found "end<block>"
             do {
                 // Read body
                 var currentBody = parser.parseUntilBlocks.apply(parser, allBlocks);
 
                 // Handle body with previous block name and args
-                if (lastBlockName) {
-                    subbodies[lastBlockName] = subbodies[lastBlockName] || [];
-                    subbodies[lastBlockName].push({
-                        body: currentBody,
-                        args: lastBlockArgs
-                    });
-                } else {
-                    body = currentBody;
-                }
+                blockNamesNode.addChild(new nodes.Literal(args.lineno, args.colno, lastBlockName));
+                blockArgCounts.addChild(new nodes.Literal(args.lineno, args.colno, lastBlockArgs.children.length));
+                bodies.push(currentBody);
+
+                // Append arguments of this block as arguments of the run function
+                _.each(lastBlockArgs.children, function(child) {
+                    args.addChild(child);
+                });
 
                 // Read new block
-                lastBlockName = parser.peekToken().value;
+                lastBlockName = parser.nextToken().value;
 
                 // Parse signature and move to the end of the block
                 if (lastBlockName != block.end) {
                     lastBlockArgs = parser.parseSignature(null, true);
-                    parser.advanceAfterBlockEnd(lastBlockName);
                 }
+
+                parser.advanceAfterBlockEnd(lastBlockName);
             } while (lastBlockName != block.end);
 
-            parser.advanceAfterBlockEnd();
-
-            var bodies = [body];
-            _.each(block.blocks, function(blockName) {
-                subbodies[blockName] = subbodies[blockName] || [];
-                if (subbodies[blockName].length === 0) {
-                    subbodies[blockName].push({
-                        args: new nodes.NodeList(),
-                        body: new nodes.NodeList()
-                    });
-                }
-
-                bodies.push(subbodies[blockName][0].body);
-            });
+            args.addChild(blockNamesNode);
+            args.addChild(blockArgCounts);
+            args.addChild(new nodes.Literal(args.lineno, args.colno, NODE_ENDARGS));
 
             return new nodes.CallExtensionAsync(this, 'run', args, bodies);
         };
 
         this.run = function(context) {
-            var args = Array.prototype.slice.call(arguments, 1);
-            var callback = args.pop();
+            var fnArgs = Array.prototype.slice.call(arguments, 1);
 
-            // Extract blocks
-            var blocks = args
-                .concat([])
-                .slice(-block.blocks.length);
+            var args;
+            var blocks = [];
+            var bodies = [];
+            var blockNames;
+            var blockArgCounts;
+            var callback;
 
-            // Eliminate blocks from list
-            if (block.blocks.length > 0) args = args.slice(0, -block.blocks.length);
+            // Extract callback
+            callback = fnArgs.pop();
 
-            // Extract main body and kwargs
-            var body = args.pop();
-            var kwargs = _.isObject(_.last(args))? args.pop() : {};
+            // Detect end of arguments
+            var endArgIndex = fnArgs.indexOf(NODE_ENDARGS);
 
-            // Extract blocks body
-            var _blocks =  _.map(block.blocks, function(blockName, i){
-                return {
-                    name: blockName,
-                    body: blocks[i]()
-                };
+            // Extract arguments and bodies
+            args = fnArgs.slice(0, endArgIndex);
+            bodies = fnArgs.slice(endArgIndex + 1);
+
+            // Extract block counts
+            blockArgCounts = args.pop();
+            blockNames = args.pop();
+
+            // Recreate list of blocks
+            _.each(blockNames, function(name, i) {
+                var countArgs = blockArgCounts[i];
+                var blockBody = bodies.shift();
+
+                var blockArgs = countArgs > 0? args.slice(0, countArgs) : [];
+                args = args.slice(countArgs);
+                var blockKwargs = extractKwargs(blockArgs);
+
+                blocks.push({
+                    name: name,
+                    body: blockBody(),
+                    args: blockArgs,
+                    kwargs: blockKwargs
+                });
             });
 
+            var mainBlock = blocks.shift();
+            mainBlock.blocks = blocks;
+
             Promise()
             .then(function() {
-                return that.applyBlock(name, {
-                    body: body(),
-                    args: args,
-                    kwargs: kwargs,
-                    blocks: _blocks
-                }, context);
+                return that.applyBlock(name, mainBlock, context);
             })
 
             // Process the block returned

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitbook",
-  "version": "3.0.0-pre.6",
+  "version": "3.0.0-pre.8",
   "homepage": "https://www.gitbook.com",
   "description": "Library and cmd utility to generate GitBooks",
   "main": "lib/index.js",
@@ -21,16 +21,17 @@
     "front-matter": "2.0.7",
     "gitbook-asciidoc": "1.1.0",
     "gitbook-markdown": "1.2.0",
-    "gitbook-plugin-fontsettings": "1.0.2",
+    "gitbook-plugin-fontsettings": "1.0.3",
     "gitbook-plugin-highlight": "2.0.2",
     "gitbook-plugin-livereload": "0.0.1",
-    "gitbook-plugin-search": "1.2.0",
-    "gitbook-plugin-sharing": "1.0.1",
-    "gitbook-plugin-theme-default": "1.0.0-pre.5",
+    "gitbook-plugin-search": "2.0.0",
+    "gitbook-plugin-lunr": "1.0.0",
+    "gitbook-plugin-theme-default": "1.0.0-pre.7",
+    "gitbook-plugin-sharing": "1.0.2",
     "github-slugid": "1.0.1",
     "graceful-fs": "4.1.3",
     "i18n-t": "1.0.0",
-    "ignore": "3.0.14",
+    "ignore": "3.1.1",
     "json-schema-defaults": "0.1.1",
     "jsonschema": "1.1.0",
     "juice": "1.10.0",

test/output-json.js

@@ -53,9 +53,10 @@ describe('JSON Output', function() {
 
         it('should correctly generate a README.json for the whole book', function() {
             output.should.have.file('README.json');
-
             var json = require(output.resolve('README.json'));
 
+            json.book.language.should.equal('en');
+
             json.should.have.property('languages')
                 .with.property('list').with.lengthOf(2);
         });

test/page.js

@@ -8,7 +8,7 @@ describe('Page', function() {
         return mock.setupDefaultBook({
             'README.md': ' # Hello World\n\nThis is a description',
             'heading.md': '# Hello\n\n## World',
-            'description.md': '# This is a title\n\nThis is the short description.\n\nNot this one.',
+            'description.md': '# This is a title\n\nThis is the short description.\n\nAnd the rest of the description.\n\n# Heading\n\nThis is not in the description',
             'frontmatter/description.md': '---\ndescription: Hello World\n---\n\n# This is a title\n\nThis is not the description',
             'frontmatter/var.md': '---\ntest: Hello World\n---\n\n{{ page.test }}',
 
@@ -141,7 +141,7 @@ describe('Page', function() {
 
             return page.toHTML(output)
             .then(function() {
-                page.attributes.description.should.equal('This is the short description.');
+                page.attributes.description.should.equal('This is the short description. And the rest of the description.');
             });
         });
     });
@@ -289,7 +289,7 @@ describe('Page', function() {
 
             it('should keep external images path', function() {
                 page.content.should.be.html({
-                    'img[src="https:/upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png"]': {
+                    'img[src="https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png"]': {
                         count: 1
                     }
                 });