Bump version to 3.1.0

Search for README file in whole summary before inserting as first article

.eslintrc

@@ -13,8 +13,10 @@
     "env": {
         "node": true,
         "browser": true,
-        "jest": true,
-        "jasmine": true
+        "mocha": true
+    },
+    "globals": {
+        "expect": true
     },
     "extends": "eslint:recommended"
 }

CHANGES.md

@@ -2,7 +2,26 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 3.0.0 (pre)
+## 3.1.0
+- Always load themes after plugins
+- README/Introduction doesn't require to be the first entry in the summary
+- Highlight active entry in summary when scrolling a page with anchors
+- Support empty parts in summary
+
+## 3.0.3
+- Fix redirection in `gitbook serve` when accessing a folder without trailing slash
+- Fix links/annotations for glossary not being correctly resolved
+- Fix regression for supporting uppercase filenames in structure files
+- Fix `gitbook install` when using Git URLs for plugins
+
+## 3.0.2
+- Fix crash for anchor links
+
+## 3.0.1
+- Fix regression in link resolution when contain anchor
+- Fix `structure.<name>` configuration not supporting filenames with dots
+
+## 3.0.0
 - Summary can contain external links and anchors (Fix [#776](https://github.com/GitbookIO/gitbook/issues/776))
 - Summary can contain differents entitled sections
 - Glossary is generated as a normal page
@@ -11,12 +30,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - `links.sidebar` configuration is no longer supported, use summary sections instead
 - `pdf.headerTemplate` and `pdf.footerTemplate` have been replaced by a template in theme/book: `_layout/ebook/pdf_header.html` and `_layout/ebook/pdf_footer.html`
 - Markdown parser is now using CommonMark
-- Root folder for the book can be specified in a `.gitbook` file
+- Root folder for the book can be specified in the `"root"` property of the `book.json` file
 - Multi-lingual books share assets folder
 - YAML front matter is parsed and can extend page's properties
 - Fix `uk` translation
 - Fix heading ID including dashes
 - Fix error in code highlighting for unknown languages
+- Fix data-uri images being handled as external images
 - Accept SSH url as plugin version
 - Add templating blocks `markdown`, `asciidoc` and `markup`
 - Better search experience

appveyor.yml

@@ -5,13 +5,18 @@ init:
 # Test against these versions of Node.js.
 environment:
   matrix:
+    - nodejs_version: "6"
     - nodejs_version: "5"
     - nodejs_version: "4"
 
+matrix:
+  fast_finish: true
+
 # Install scripts. (runs after repo cloning)
 install:
   # Get the latest stable version of Node.js or io.js
   - ps: Install-Product node $env:nodejs_version
+  - set CI=true
   # install svgexport
   - npm install svgexport -g
   # install modules
@@ -27,3 +32,7 @@ test_script:
 
 # Don't actually build.
 build: off
+
+# Clone only last commit
+shallow_clone: true
+clone_depth: 1

docs/config.md

@@ -7,6 +7,7 @@ GitBook allows you to customize your book using a flexible configuration. These
 | Variable | Description |
 | -------- | ----------- |
 | `root` | Path to the root folder containing all the book's files, except `book.json`|
+| `structure` | To specify paths for Readme, Summary, Glossary etc. See [Structure paragraph](#structure). |
 | `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
 | `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
 | `author` | Name of the author. On GitBook.com this field is pre-filled. |
@@ -32,6 +33,18 @@ Since version 3.0.0, GitBook can use themes. See [the theming section](themes/RE
 | -------- | ----------- |
 | `theme` | The theme to use for the book |
 
+### Structure
+
+In addition to the `root` variable, you can tell Gitbook the name of the files for Readme, Summary, Glossary, Languages (instead of using the default names such as `README.md`).
+These files must be at the root of your book (or the root of every language book). Paths such as `dir/MY_README.md` are not accepted.
+
+| Variable | Description |
+| -------- | ----------- |
+| `structure.readme` | Readme file name (defaults to `README.md`) |
+| `structure.summary` | Summary file name (defaults to `SUMMARY.md`) |
+| `structure.glossary` | Glossary file name (defaults to `GLOSSARY.md`) |
+| `structure.languages` | Languages file name (defaults to `LANGS.md`) |
+
 ### PDF Options
 
 PDF Output can be customized using a set of options in the `book.json`:

docs/lexicon.md

@@ -2,13 +2,13 @@
 
 Allows you to specify terms and their respective definitions to be displayed as annotations. Based on those terms, GitBook will automatically build an index and highlight those terms in pages.
 
-The `GLOSSARY.md` format is very simple :
+The `GLOSSARY.md` format is a list of `h2` headings, along with a description paragraph:
 
 ```markdown
-# Term
+## Term
 Definition for this term
 
-# Another term
+## Another term
 With it's definition, this can contain bold text
 and all other kinds of inline markup ...
 ```

docs/plugins/api.md

@@ -37,7 +37,7 @@ var filepath = output.resolve('myimage.png');
 var fileurl = output.toURL('mychapter/README.md');
 
 // Write a file in the output folder
-output.write('hello.txt', 'Hello World')
+output.writeFile('hello.txt', 'Hello World')
     .then(function() { ... });
 
 // Copy a file to the output folder

docs/setup.md

@@ -14,7 +14,7 @@ It integrates well with the [GitBook Editor](https://www.gitbook.com/editor).
 
 Installing GitBook is easy and straightforward. Your system just needs to meet these two requirements:
 
-* NodeJS (v4.0.0 and above are adviced)
+* NodeJS (v4.0.0 and above is recommended)
 * Windows, Linux, Unix, or Mac OS X
 
 ##### Install with NPM

docs/templating/conrefs.md

@@ -51,5 +51,5 @@ This is the default content
 
 # License
 
-{% import "./LICENSE" %}
+{% include "./LICENSE" %}
 ```

jest/customMatchers.js

@@ -1,25 +0,0 @@
-var path = require('path');
-var fs = require('fs');
-
-var matchers = {
-    /**
-        Verify that a file exists in a directory
-    */
-    toHaveFile: function () {
-        return {
-            compare: function (actual, expected) {
-                var filePath = path.join(actual, expected);
-                var exists = fs.existsSync(filePath);
-
-                return {
-                    pass: exists
-                };
-            }
-        };
-    }
-};
-
-jasmine.getEnv().beforeEach(function () {
-    jasmine.DEFAULT_TIMEOUT_INTERVAL = 20000;
-    jasmine.addMatchers(matchers);
-});

lib/__tests__/init.js

@@ -3,7 +3,7 @@ var initBook = require('../init');
 
 describe('initBook', function() {
 
-    pit('should create a README and SUMMARY for empty book', function() {
+    it('should create a README and SUMMARY for empty book', function() {
         var dir = tmp.dirSync();
 
         return initBook(dir.name)

lib/api/decodeConfig.js

@@ -1,5 +1,3 @@
-var Config = require('../models/config');
-
 /**
     Decode changes from a JS API to a config object
 
@@ -13,7 +11,7 @@ function decodeGlobal(config, result) {
     delete values.generator;
     delete values.output;
 
-    return Config.updateValues(config, values);
+    return config.updateValues(values);
 }
 
 module.exports = decodeGlobal;

lib/api/encodeGlobal.js

@@ -1,14 +1,19 @@
+var path = require('path');
 var Promise = require('../utils/promise');
 var PathUtils = require('../utils/path');
 var fs = require('../utils/fs');
 
 var Plugins = require('../plugins');
 var deprecate = require('./deprecate');
-var encodeConfig = require('./encodeConfig');
-var encodeNavigation = require('./encodeNavigation');
 var fileToURL = require('../output/helper/fileToURL');
 var defaultBlocks = require('../constants/defaultBlocks');
 var gitbook = require('../gitbook');
+var parsers = require('../parsers');
+
+var encodeConfig = require('./encodeConfig');
+var encodeSummary = require('./encodeSummary');
+var encodeNavigation = require('./encodeNavigation');
+var encodePage = require('./encodePage');
 
 /**
     Encode a global context into a JS object
@@ -28,6 +33,7 @@ function encodeGlobal(output) {
     var result = {
         log: logger,
         config: encodeConfig(output, book.getConfig()),
+        summary: encodeSummary(output, book.getSummary()),
 
         /**
             Check if the book is a multilingual book
@@ -67,6 +73,57 @@ function encodeGlobal(output) {
             return bookFS.readAsString(fileName);
         },
 
+        /**
+            Resolve a file from the book root
+
+            @param {String} fileName
+            @return {String}
+        */
+        resolve: function(fileName) {
+            return path.resolve(book.getContentRoot(), fileName);
+        },
+
+        /**
+            Resolve a page by it path
+
+            @param {String} filePath
+            @return {String}
+        */
+        getPageByPath: function(filePath) {
+            var page = output.getPage(filePath);
+            if (!page) return undefined;
+
+            return encodePage(output, page);
+        },
+
+        /**
+            Render a block of text (markdown/asciidoc)
+
+            @param {String} type
+            @param {String} text
+            @return {Promise<String>}
+        */
+        renderBlock: function(type, text) {
+            var parser = parsers.get(type);
+
+            return parser.parsePage(text)
+                .get('content');
+        },
+
+        /**
+            Render an inline text (markdown/asciidoc)
+
+            @param {String} type
+            @param {String} text
+            @return {Promise<String>}
+        */
+        renderInline: function(type, text) {
+            var parser = parsers.get(type);
+
+            return parser.parseInline(text)
+                .get('content');
+        },
+
         template: {
             /**
                 Apply a templating block and returns its result
@@ -96,6 +153,16 @@ function encodeGlobal(output) {
                 return outputFolder;
             },
 
+            /**
+                Resolve a file from the output root
+
+                @param {String} fileName
+                @return {String}
+            */
+            resolve: function(fileName) {
+                return path.resolve(outputFolder, fileName);
+            },
+
             /**
                 Convert a filepath into an url
                 @return {String}
@@ -104,6 +171,21 @@ function encodeGlobal(output) {
                 return fileToURL(output, filePath);
             },
 
+            /**
+                Check that a file exists.
+
+                @param {String} fileName
+                @return {Promise}
+            */
+            hasFile: function(fileName, content) {
+                return Promise()
+                .then(function() {
+                    var filePath = PathUtils.resolveInRoot(outputFolder, fileName);
+
+                    return fs.exists(filePath);
+                });
+            },
+
             /**
                 Write a file to the output folder,
                 It creates the required folder
@@ -122,6 +204,27 @@ function encodeGlobal(output) {
                         return fs.writeFile(filePath, content);
                     });
                 });
+            },
+
+            /**
+                Copy a file to the output folder
+                It creates the required folder.
+
+                @param {String} inputFile
+                @param {String} outputFile
+                @param {Buffer} content
+                @return {Promise}
+            */
+            copyFile: function(inputFile, outputFile, content) {
+                return Promise()
+                .then(function() {
+                    var outputFilePath = PathUtils.resolveInRoot(outputFolder, outputFile);
+
+                    return fs.ensureFile(outputFilePath)
+                    .then(function() {
+                        return fs.copy(inputFile, outputFilePath);
+                    });
+                });
             }
         },
 

lib/api/encodeSummary.js

@@ -0,0 +1,51 @@
+var encodeSummaryArticle = require('../json/encodeSummaryArticle');
+
+/**
+    Encode summary to provide an API to plugin
+
+    @param {Output} output
+    @param {Config} config
+    @return {Object}
+*/
+function encodeSummary(output, summary) {
+    var result = {
+        /**
+            Iterate over the summary, it stops when the "iter" returns false
+
+            @param {Function} iter
+        */
+        walk: function (iter) {
+            summary.getArticle(function(article) {
+                var jsonArticle = encodeSummaryArticle(article, false);
+
+                return iter(jsonArticle);
+            });
+        },
+
+        /**
+            Get an article by its level
+
+            @param {String} level
+            @return {Object}
+        */
+        getArticleByLevel: function(level) {
+            var article = summary.getByLevel(level);
+            return (article? encodeSummaryArticle(article) : undefined);
+        },
+
+        /**
+            Get an article by its path
+
+            @param {String} level
+            @return {Object}
+        */
+        getArticleByPath: function(level) {
+            var article = summary.getByPath(level);
+            return (article? encodeSummaryArticle(article) : undefined);
+        }
+    };
+
+    return result;
+}
+
+module.exports = encodeSummary;

lib/browser.js

@@ -11,5 +11,9 @@ module.exports = {
 
     // Modifiers
     SummaryModifier: Modifiers.Summary,
-    ConfigModifier: Modifiers.Config
+    ConfigModifier: Modifiers.Config,
+
+    // Constants
+    CONFIG_FILES:       require('./constants/configFiles.js'),
+    IGNORE_FILES:       require('./constants/ignoreFiles.js')
 };

lib/cli/buildEbook.js

@@ -18,8 +18,10 @@ module.exports = function(format) {
             options.log
         ],
         exec: function(args, kwargs) {
+            var extension = '.' + format;
+
             // Output file will be stored in
-            var outputFile = args[1] || ('book.' + format);
+            var outputFile = args[1] || ('book' + extension);
 
             // Create temporary directory
             var outputFolder = tmp.dirSync().name;
@@ -42,23 +44,23 @@ module.exports = function(format) {
                 var languages = book.getLanguages();
 
                 if (book.isMultilingual()) {
-                    return Promise.ForEach(languages, function(lang) {
+                    return Promise.forEach(languages.getList(), function(lang) {
                         var langID = lang.getID();
 
                         var langOutputFile = path.join(
                             path.dirname(outputFile),
-                            path.basename(outputFile, format) + '_' + langID + '.' + format
+                            path.basename(outputFile, extension) + '_' + langID + extension
                         );
 
                         return fs.copy(
-                            path.resolve(outputFolder, langID, 'index.' + format),
+                            path.resolve(outputFolder, langID, 'index' + extension),
                             langOutputFile
                         );
                     })
                     .thenResolve(languages.getCount());
                 } else {
                     return fs.copy(
-                        path.resolve(outputFolder, 'index.' + format),
+                        path.resolve(outputFolder, 'index' + extension),
                         outputFile
                     ).thenResolve(1);
                 }

lib/cli/init.js

@@ -4,7 +4,7 @@ var options = require('./options');
 var initBook = require('../init');
 
 module.exports = {
-    name: 'install [book]',
+    name: 'init [book]',
     description: 'setup and create files for chapters',
     options: [
         options.log

lib/cli/serve.js

@@ -16,12 +16,26 @@ var watch = require('./watch');
 
 var server, lrServer, lrPath;
 
+function waitForCtrlC() {
+    var d = Promise.defer();
+
+    process.on('SIGINT', function() {
+        d.resolve();
+    });
+
+    return d.promise;
+}
+
+
 function generateBook(args, kwargs) {
     var port = kwargs.port;
     var outputFolder = getOutputFolder(args);
     var book = getBook(args, kwargs);
     var Generator = Output.getGenerator(kwargs.format);
 
+    var hasWatch = kwargs['watch'];
+    var hasLiveReloading = kwargs['live'];
+
     // Stop server if running
     if (server.isRunning()) console.log('Stopping server');
 
@@ -29,8 +43,10 @@ function generateBook(args, kwargs) {
     .then(function() {
         return Parse.parseBook(book)
         .then(function(resultBook) {
-            // Enable livereload plugin
-            resultBook = ConfigModifier.addPlugin(resultBook, 'livereload');
+            if (hasLiveReloading) {
+                // Enable livereload plugin
+                resultBook = ConfigModifier.addPlugin(resultBook, 'livereload');
+            }
 
             return Output.generate(Generator, resultBook, {
                 root: outputFolder
@@ -45,7 +61,7 @@ function generateBook(args, kwargs) {
     .then(function() {
         console.log('Serving book on http://localhost:'+port);
 
-        if (lrPath) {
+        if (lrPath && hasLiveReloading) {
             // trigger livereload
             lrServer.changed({
                 body: {
@@ -55,7 +71,9 @@ function generateBook(args, kwargs) {
         }
     })
     .then(function() {
-        if (!kwargs.watch) return;
+        if (!hasWatch) {
+            return waitForCtrlC();
+        }
 
         return watch(book.getRoot())
         .then(function(filepath) {
@@ -84,7 +102,12 @@ module.exports = {
         },
         {
             name: 'watch',
-            description: 'Enable/disable file watcher',
+            description: 'Enable file watcher and live reloading',
+            defaults: true
+        },
+        {
+            name: 'live',
+            description: 'Enable live reloading',
             defaults: true
         },
         options.log,
@@ -92,13 +115,25 @@ module.exports = {
     ],
     exec: function(args, kwargs) {
         server = new Server();
-        lrServer = tinylr({});
+        var hasWatch = kwargs['watch'];
+        var hasLiveReloading = kwargs['live'];
 
-        return Promise.nfcall(lrServer.listen.bind(lrServer), kwargs.lrport)
+        return Promise()
+        .then(function() {
+            if (!hasWatch || !hasLiveReloading) {
+                return;
+            }
+
+            lrServer = tinylr({});
+            return Promise.nfcall(lrServer.listen.bind(lrServer), kwargs.lrport)
+            .then(function() {
+                console.log('Live reload server started on port:', kwargs.lrport);
+                console.log('Press CTRL+C to quit ...');
+                console.log('');
+
+            });
+        })
         .then(function() {
-            console.log('Live reload server started on port:', kwargs.lrport);
-            console.log('Press CTRL+C to quit ...');
-            console.log('');
             return generateBook(args, kwargs);
         });
     }

lib/cli/server.js

@@ -71,11 +71,18 @@ Server.prototype.start = function(dir, port) {
 
             // Redirect to directory's index.html
             function redirect() {
+                var resultURL = urlTransform(req.url, function(parsed) {
+                    parsed.pathname += '/';
+                    return parsed;
+                });
+
                 res.statusCode = 301;
-                res.setHeader('Location', req.url + '/');
-                res.end('Redirecting to ' + req.url + '/');
+                res.setHeader('Location', resultURL);
+                res.end('Redirecting to ' + resultURL);
             }
 
+            res.setHeader('X-Current-Location', req.url);
+
             // Send file
             send(req, url.parse(req.url).pathname, {
                 root: dir
@@ -106,4 +113,16 @@ Server.prototype.start = function(dir, port) {
     });
 };
 
+/**
+    urlTransform is a helper function that allows a function to transform
+    a url string in it's parsed form and returns the new url as a string
+
+    @param {String} uri
+    @param {Function} fn
+    @return {String}
+*/
+function urlTransform(uri, fn) {
+    return url.format(fn(url.parse(uri)));
+}
+
 module.exports = Server;

lib/constants/__tests__/configSchema.js

@@ -0,0 +1,46 @@
+var jsonschema = require('jsonschema');
+var schema = require('../configSchema');
+
+describe('configSchema', function() {
+
+    function validate(cfg) {
+        var v = new jsonschema.Validator();
+        return v.validate(cfg, schema, {
+            propertyName: 'config'
+        });
+    }
+
+    describe('structure', function() {
+
+        it('should accept dot in filename', function() {
+            var result = validate({
+                structure: {
+                    readme: 'book-intro.adoc'
+                }
+            });
+
+            expect(result.errors.length).toBe(0);
+        });
+
+        it('should accept uppercase in filename', function() {
+            var result = validate({
+                structure: {
+                    readme: 'BOOK.adoc'
+                }
+            });
+
+            expect(result.errors.length).toBe(0);
+        });
+
+        it('should not accept filepath', function() {
+            var result = validate({
+                structure: {
+                    readme: 'folder/myFile.md'
+                }
+            });
+
+            expect(result.errors.length).toBe(1);
+        });
+
+    });
+});

lib/constants/configSchema.js

@@ -1,3 +1,5 @@
+var FILENAME_REGEX = '^[a-zA-Z-._\d,\s]+$';
+
 module.exports = {
     '$schema': 'http://json-schema.org/schema#',
     'id': 'https://gitbook.com/schemas/book.json',
@@ -57,25 +59,25 @@ module.exports = {
                     'default': 'LANGS.md',
                     'type': 'string',
                     'title': 'File to use as languages index',
-                    'pattern': '^[0-9a-zA-Z ... ]+$'
+                    'pattern': FILENAME_REGEX
                 },
                 'readme': {
                     'default': 'README.md',
                     'type': 'string',
                     'title': 'File to use as preface',
-                    'pattern': '^[0-9a-zA-Z ... ]+$'
+                    'pattern': FILENAME_REGEX
                 },
                 'glossary': {
                     'default': 'GLOSSARY.md',
                     'type': 'string',
                     'title': 'File to use as glossary index',
-                    'pattern': '^[0-9a-zA-Z ... ]+$'
+                    'pattern': FILENAME_REGEX
                 },
                 'summary': {
                     'default': 'SUMMARY.md',
                     'type': 'string',
                     'title': 'File to use as table of contents',
-                    'pattern': '^[0-9a-zA-Z ... ]+$'
+                    'pattern': FILENAME_REGEX
                 }
             },
             'additionalProperties': false

lib/constants/themePrefix.js

@@ -0,0 +1,4 @@
+/*
+    All GitBook themes plugins name start with this prefix once shorted.
+*/
+module.exports = 'theme-';

lib/fs/__tests__/mock.js

@@ -1,7 +1,6 @@
-jest.autoMockOff();
+var createMockFS = require('../mock');
 
 describe('MockFS', function() {
-    var createMockFS = require('../mock');
     var fs = createMockFS({
         'README.md': 'Hello World',
         'SUMMARY.md': '# Summary',
@@ -15,35 +14,35 @@ describe('MockFS', function() {
     });
 
     describe('exists', function() {
-        pit('must return true for a file', function() {
+        it('must return true for a file', function() {
             return fs.exists('README.md')
             .then(function(result) {
                 expect(result).toBeTruthy();
             });
         });
 
-        pit('must return false for a non existing file', function() {
+        it('must return false for a non existing file', function() {
             return fs.exists('README_NOTEXISTS.md')
             .then(function(result) {
                 expect(result).toBeFalsy();
             });
         });
 
-        pit('must return true for a directory', function() {
+        it('must return true for a directory', function() {
             return fs.exists('folder')
             .then(function(result) {
                 expect(result).toBeTruthy();
             });
         });
 
-        pit('must return true for a deep file', function() {
+        it('must return true for a deep file', function() {
             return fs.exists('folder/test.md')
             .then(function(result) {
                 expect(result).toBeTruthy();
             });
         });
 
-        pit('must return true for a deep file (2)', function() {
+        it('must return true for a deep file (2)', function() {
             return fs.exists('folder/folder2/hello.md')
             .then(function(result) {
                 expect(result).toBeTruthy();
@@ -52,14 +51,14 @@ describe('MockFS', function() {
     });
 
     describe('readAsString', function() {
-        pit('must return content for a file', function() {
+        it('must return content for a file', function() {
             return fs.readAsString('README.md')
             .then(function(result) {
                 expect(result).toBe('Hello World');
             });
         });
 
-        pit('must return content for a deep file', function() {
+        it('must return content for a deep file', function() {
             return fs.readAsString('folder/test.md')
             .then(function(result) {
                 expect(result).toBe('Cool');
@@ -68,7 +67,7 @@ describe('MockFS', function() {
     });
 
     describe('readDir', function() {
-        pit('must return content for a directory', function() {
+        it('must return content for a directory', function() {
             return fs.readDir('./')
             .then(function(files) {
                 expect(files.size).toBe(3);

lib/fs/mock.js

@@ -16,7 +16,7 @@ function createMockFS(files) {
     var mtime = new Date();
 
     function getFile(filePath) {
-        var parts = path.normalize(filePath).split('/');
+        var parts = path.normalize(filePath).split(path.sep);
         return parts.reduce(function(list, part, i) {
             if (!list) return null;
 

lib/fs/node.js

@@ -36,6 +36,7 @@ module.exports = function createNodeFS(root) {
         fsReadFile: fs.readFile,
         fsStatFile: fs.stat,
         fsReadDir: fsReadDir,
-        fsLoadObject: fsLoadObject
+        fsLoadObject: fsLoadObject,
+        fsReadAsStream: fs.readStream
     });
 };

lib/init.js

@@ -47,8 +47,11 @@ function initBook(rootFolder) {
 
         // Write pages
         return Promise.forEach(articles, function(article) {
-            var filePath = path.join(rootFolder, article.getPath());
-            if (!filePath) return;
+            var articlePath = article.getPath();
+            var filePath = articlePath? path.join(rootFolder, articlePath) : null;
+            if (!filePath) {
+                return;
+            }
 
             return fs.assertFile(filePath, function() {
                 return fs.ensureFile(filePath)

lib/json/encodeBook.js

@@ -4,6 +4,7 @@ var gitbook = require('../gitbook');
 var encodeSummary = require('./encodeSummary');
 var encodeGlossary = require('./encodeGlossary');
 var encodeReadme = require('./encodeReadme');
+var encodeLanguages = require('./encodeLanguages');
 
 /**
     Encode a book to JSON
@@ -22,6 +23,9 @@ function encodeBookToJson(book) {
         glossary: encodeGlossary(book.getGlossary()),
         readme: encodeReadme(book.getReadme()),
         config: book.getConfig().getValues().toJS(),
+
+        languages: book.isMultilingual()? encodeLanguages(book.getLanguages()) : undefined,
+
         gitbook: {
             version: gitbook.version,
             time: gitbook.START_TIME

lib/json/encodeLanguages.js

@@ -0,0 +1,26 @@
+var encodeFile = require('./encodeFile');
+
+/**
+    Encode a languages listing to JSON
+
+    @param {Languages}
+    @return {Object}
+*/
+function encodeLanguages(languages) {
+    var file = languages.getFile();
+    var list = languages.getList();
+
+    return {
+        file: encodeFile(file),
+        list: list
+            .valueSeq()
+            .map(function(lang) {
+                return {
+                    id: lang.getID(),
+                    title: lang.getTitle()
+                };
+            }).toJS()
+    };
+}
+
+module.exports = encodeLanguages;

lib/json/encodeSummaryArticle.js

@@ -20,6 +20,7 @@ function encodeSummaryArticle(article, recursive) {
         anchor: article.getAnchor(),
         url: article.getUrl(),
         path: article.getPath(),
+        ref: article.getRef(),
         articles: articles
     };
 }

lib/json/index.js

@@ -7,5 +7,6 @@ module.exports = {
     encodePage:             require('./encodePage'),
     encodeSummary:          require('./encodeSummary'),
     encodeSummaryArticle:   require('./encodeSummaryArticle'),
-    encodeReadme:           require('./encodeReadme')
+    encodeReadme:           require('./encodeReadme'),
+    encodeLanguages:        require('./encodeLanguages')
 };

lib/models/__tests__/config.js

@@ -1,10 +1,7 @@
-jest.autoMockOff();
-
 var Immutable = require('immutable');
+var Config = require('../config');
 
 describe('Config', function() {
-    var Config = require('../config');
-
     var config = Config.createWithValues({
         hello: {
             world: 1,

lib/models/__tests__/glossary.js

@@ -1,10 +1,8 @@
-jest.autoMockOff();
+var File = require('../file');
+var Glossary = require('../glossary');
+var GlossaryEntry = require('../glossaryEntry');
 
 describe('Glossary', function() {
-    var File = require('../file');
-    var Glossary = require('../glossary');
-    var GlossaryEntry = require('../glossaryEntry');
-
     var glossary = Glossary.createFromEntries(File(), [
         {
             name: 'Hello World',
@@ -30,7 +28,7 @@ describe('Glossary', function() {
     });
 
     describe('toText', function() {
-        pit('return as markdown', function() {
+        it('return as markdown', function() {
             return glossary.toText('.md')
             .then(function(text) {
                 expect(text).toContain('# Glossary');

lib/models/__tests__/glossaryEntry.js

@@ -1,8 +1,6 @@
-jest.autoMockOff();
+var GlossaryEntry = require('../glossaryEntry');
 
 describe('GlossaryEntry', function() {
-    var GlossaryEntry = require('../glossaryEntry');
-
     describe('getID', function() {
         it('must return a normalized ID', function() {
             var entry = new GlossaryEntry({

lib/models/__tests__/plugin.js

@@ -1,5 +1,3 @@
-jest.autoMockOff();
-
 describe('Plugin', function() {
     var Plugin = require('../plugin');
 

lib/models/__tests__/pluginDependency.js

@@ -0,0 +1,80 @@
+var Immutable = require('immutable');
+var PluginDependency = require('../pluginDependency');
+
+describe('PluginDependency', function() {
+    describe('createFromString', function() {
+        it('must parse name', function() {
+            var plugin = PluginDependency.createFromString('hello');
+            expect(plugin.getName()).toBe('hello');
+            expect(plugin.getVersion()).toBe('*');
+        });
+
+        it('must parse state', function() {
+            var plugin = PluginDependency.createFromString('-hello');
+            expect(plugin.getName()).toBe('hello');
+            expect(plugin.isEnabled()).toBe(false);
+        });
+
+        describe('Version', function() {
+            it('must parse version', function() {
+                var plugin = PluginDependency.createFromString('hello@1.0.0');
+                expect(plugin.getName()).toBe('hello');
+                expect(plugin.getVersion()).toBe('1.0.0');
+            });
+
+            it('must parse semver', function() {
+                var plugin = PluginDependency.createFromString('hello@>=4.0.0');
+                expect(plugin.getName()).toBe('hello');
+                expect(plugin.getVersion()).toBe('>=4.0.0');
+            });
+        });
+
+        describe('GIT Version', function() {
+            it('must handle HTTPS urls', function() {
+                var plugin = PluginDependency.createFromString('hello@git+https://github.com/GitbookIO/plugin-ga.git');
+                expect(plugin.getName()).toBe('hello');
+                expect(plugin.getVersion()).toBe('git+https://github.com/GitbookIO/plugin-ga.git');
+            });
+
+            it('must handle SSH urls', function() {
+                var plugin = PluginDependency.createFromString('hello@git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
+                expect(plugin.getName()).toBe('hello');
+                expect(plugin.getVersion()).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
+            });
+        });
+
+        describe('listToArray', function() {
+            it('must create an array from a list of plugin dependencies', function() {
+                var list = PluginDependency.listToArray(Immutable.List([
+                    PluginDependency.createFromString('hello@1.0.0'),
+                    PluginDependency.createFromString('noversion'),
+                    PluginDependency.createFromString('-disabled')
+                ]));
+
+                expect(list).toEqual([
+                    'hello@1.0.0',
+                    'noversion',
+                    '-disabled'
+                ]);
+            });
+        });
+
+        describe('listFromArray', function() {
+            it('must create an array from a list of plugin dependencies', function() {
+                var arr = Immutable.fromJS([
+                    'hello@1.0.0',
+                    {
+                        'name': 'plugin-ga',
+                        'version': 'git+ssh://samy@github.com/GitbookIO/plugin-ga.git'
+                    }
+                ]);
+                var list = PluginDependency.listFromArray(arr);
+
+                expect(list.first().getName()).toBe('hello');
+                expect(list.first().getVersion()).toBe('1.0.0');
+                expect(list.last().getName()).toBe('plugin-ga');
+                expect(list.last().getVersion()).toBe('git+ssh://samy@github.com/GitbookIO/plugin-ga.git');
+            });
+        });
+    });
+});

lib/models/__tests__/summary.js

@@ -8,11 +8,18 @@ describe('Summary', function() {
             articles: [
                 {
                     title: 'My First Article',
-                    path: 'README.md'
+                    ref: 'README.md'
                 },
                 {
                     title: 'My Second Article',
-                    path: 'article.md'
+                    ref: 'article.md'
+                },
+                {
+                    title: 'Article without ref'
+                },
+                {
+                    title: 'Article with absolute ref',
+                    ref: 'https://google.fr'
                 }
             ]
         },
@@ -33,7 +40,7 @@ describe('Summary', function() {
             var part = summary.getByLevel('1');
 
             expect(part).toBeDefined();
-            expect(part.getArticles().size).toBe(2);
+            expect(part.getArticles().size).toBe(4);
         });
 
         it('can return a Part (2)', function() {
@@ -66,10 +73,16 @@ describe('Summary', function() {
             expect(article).toBeDefined();
             expect(article.getTitle()).toBe('My Second Article');
         });
+
+        it('return undefined if not found', function() {
+            var article = summary.getByPath('NOT_EXISTING.md');
+
+            expect(article).toBeFalsy();
+        });
     });
 
     describe('toText', function() {
-        pit('return as markdown', function() {
+        it('return as markdown', function() {
             return summary.toText('.md')
             .then(function(text) {
                 expect(text).toContain('# Summary');

lib/models/__tests__/templateBlock.js

@@ -6,18 +6,18 @@ describe('TemplateBlock', function() {
     var TemplateBlock = require('../templateBlock');
 
     describe('create', function() {
-        pit('must initialize a simple TemplateBlock from a function', function() {
+        it('must initialize a simple TemplateBlock from a function', function() {
             var templateBlock = TemplateBlock.create('sayhello', function(block) {
-                return '<p>Hello, World!</p>';
+                return {
+                    body: '<p>Hello, World!</p>',
+                    parse: true
+                };
             });
 
             // Check basic templateBlock properties
             expect(templateBlock.getName()).toBe('sayhello');
-            expect(templateBlock.getPost()).toBeNull();
-            expect(templateBlock.getParse()).toBeTruthy();
             expect(templateBlock.getEndTag()).toBe('endsayhello');
             expect(templateBlock.getBlocks().size).toBe(0);
-            expect(templateBlock.getShortcuts().size).toBe(0);
             expect(templateBlock.getExtensionName()).toBe('BlocksayhelloExtension');
 
             // Check result of applying block
@@ -32,10 +32,77 @@ describe('TemplateBlock', function() {
         });
     });
 
-    describe('toNunjucksExt()', function() {
-        pit('must create a valid nunjucks extension', function() {
+    describe('getShortcuts', function() {
+        it('must return undefined if no shortcuts', function() {
             var templateBlock = TemplateBlock.create('sayhello', function(block) {
-                return '<p>Hello, World!</p>';
+                return {
+                    body: '<p>Hello, World!</p>',
+                    parse: true
+                };
+            });
+
+            expect(templateBlock.getShortcuts()).toNotExist();
+        });
+
+        it('must return complete shortcut', function() {
+            var templateBlock = TemplateBlock.create('sayhello', {
+                process: function(block) {
+                    return '<p>Hello, World!</p>';
+                },
+                shortcuts: {
+                    parsers: ['markdown'],
+                    start: '$',
+                    end: '-'
+                }
+            });
+
+            var shortcut = templateBlock.getShortcuts();
+
+            expect(shortcut).toBeDefined();
+            expect(shortcut.getStart()).toEqual('$');
+            expect(shortcut.getEnd()).toEqual('-');
+            expect(shortcut.getStartTag()).toEqual('sayhello');
+            expect(shortcut.getEndTag()).toEqual('endsayhello');
+        });
+    });
+
+    describe('toNunjucksExt()', function() {
+        it('should replace by block anchor', function() {
+            var templateBlock = TemplateBlock.create('sayhello', function(block) {
+                return 'Hello';
+            });
+
+            var blocks = {};
+
+            // Create a fresh Nunjucks environment
+            var env = new nunjucks.Environment(null, { autoescape: false });
+
+            // Add template block to environement
+            var Ext = templateBlock.toNunjucksExt({}, blocks);
+            env.addExtension(templateBlock.getExtensionName(), new Ext());
+
+            // Render a template using the block
+            var src = '{% sayhello %}{% endsayhello %}';
+            return Promise.nfcall(env.renderString.bind(env), src)
+            .then(function(res) {
+                blocks = Immutable.fromJS(blocks);
+                expect(blocks.size).toBe(1);
+
+                var blockId = blocks.keySeq().get(0);
+                var block = blocks.get(blockId);
+
+                expect(res).toBe('{{-%' + blockId + '%-}}');
+                expect(block.get('body')).toBe('Hello');
+                expect(block.get('name')).toBe('sayhello');
+            });
+        });
+
+        it('must create a valid nunjucks extension', function() {
+            var templateBlock = TemplateBlock.create('sayhello', function(block) {
+                return {
+                    body: '<p>Hello, World!</p>',
+                    parse: true
+                };
             });
 
             // Create a fresh Nunjucks environment
@@ -53,9 +120,12 @@ describe('TemplateBlock', function() {
             });
         });
 
-        pit('must apply block arguments correctly', function() {
+        it('must apply block arguments correctly', function() {
             var templateBlock = TemplateBlock.create('sayhello', function(block) {
-                return '<'+block.kwargs.tag+'>Hello, '+block.kwargs.name+'!</'+block.kwargs.tag+'>';
+                return {
+                    body: '<'+block.kwargs.tag+'>Hello, '+block.kwargs.name+'!</'+block.kwargs.tag+'>',
+                    parse: true
+                };
             });
 
             // Create a fresh Nunjucks environment
@@ -73,11 +143,14 @@ describe('TemplateBlock', function() {
             });
         });
 
-        pit('must accept an async function', function() {
+        it('must accept an async function', function() {
             var templateBlock = TemplateBlock.create('sayhello', function(block) {
                 return Promise()
                 .then(function() {
-                    return 'Hello ' + block.body;
+                    return {
+                        body: 'Hello ' + block.body,
+                        parse: true
+                    };
                 });
             });
 
@@ -96,7 +169,7 @@ describe('TemplateBlock', function() {
             });
         });
 
-        pit('must handle nested blocks', function() {
+        it('must handle nested blocks', function() {
             var templateBlock = new TemplateBlock({
                 name: 'yoda',
                 blocks: Immutable.List(['start', 'end']),
@@ -107,7 +180,10 @@ describe('TemplateBlock', function() {
                         nested[blk.name] = blk.body.trim();
                     });
 
-                    return '<p class="yoda">'+nested.end+' '+nested.start+'</p>';
+                    return {
+                        body: '<p class="yoda">'+nested.end+' '+nested.start+'</p>',
+                        parse: true
+                    };
                 }
             });
 

lib/models/book.js

@@ -1,6 +1,5 @@
 var path = require('path');
 var Immutable = require('immutable');
-var Ignore = require('ignore');
 
 var Logger = require('../utils/logger');
 
@@ -10,7 +9,7 @@ var Readme = require('./readme');
 var Summary = require('./summary');
 var Glossary = require('./glossary');
 var Languages = require('./languages');
-
+var Ignore = require('./ignore');
 
 var Book = Immutable.Record({
     // Logger for outptu message
@@ -128,8 +127,7 @@ Book.prototype.isFileIgnored = function(filename) {
         filename = path.join(language, filename);
     }
 
-
-    return ignore.filter([filename]).length == 0;
+    return ignore.isFileIgnored(filename);
 };
 
 /**
@@ -177,6 +175,17 @@ Book.prototype.isLanguageBook = function() {
     return Boolean(this.getLanguage());
 };
 
+/**
+    Return a languages book
+
+    @param {String} language
+    @return {Book}
+*/
+Book.prototype.getLanguageBook = function(language) {
+    var books = this.getBooks();
+    return books.get(language);
+};
+
 /**
     Add a new language book
 
@@ -221,6 +230,16 @@ Book.prototype.setConfig = function(config) {
     return this.set('config', config);
 };
 
+/**
+    Set the ignore instance for this book
+
+    @param {Ignore}
+    @return {Book}
+*/
+Book.prototype.setIgnore = function(ignore) {
+    return this.set('ignore', ignore);
+};
+
 /**
     Change log level
 
@@ -244,6 +263,79 @@ Book.createForFS = function createForFS(fs) {
     });
 };
 
+/**
+    Infers the default extension for files
+    @return {String}
+*/
+Book.prototype.getDefaultExt = function() {
+    // Inferring sources
+    var clues = [
+        this.getReadme(),
+        this.getSummary(),
+        this.getGlossary()
+    ];
+
+    // List their extensions
+    var exts = clues.map(function (clue) {
+        var file = clue.getFile();
+        if (file.exists()) {
+            return file.getParser().getExtensions().first();
+        } else {
+            return null;
+        }
+    });
+    // Adds the general default extension
+    exts.push('.md');
+
+    // Choose the first non null
+    return exts.find(function (e) { return e !== null; });
+};
+
+/**
+    Infer the default path for a Readme.
+    @param {Boolean} [absolute=false] False for a path relative to
+        this book's content root
+    @return {String}
+*/
+Book.prototype.getDefaultReadmePath = function(absolute) {
+    var defaultPath = 'README'+this.getDefaultExt();
+    if (absolute) {
+        return path.join(this.getContentRoot(), defaultPath);
+    } else {
+        return defaultPath;
+    }
+};
+
+/**
+    Infer the default path for a Summary.
+    @param {Boolean} [absolute=false] False for a path relative to
+        this book's content root
+    @return {String}
+*/
+Book.prototype.getDefaultSummaryPath = function(absolute) {
+    var defaultPath = 'SUMMARY'+this.getDefaultExt();
+    if (absolute) {
+        return path.join(this.getContentRoot(), defaultPath);
+    } else {
+        return defaultPath;
+    }
+};
+
+/**
+    Infer the default path for a Glossary.
+    @param {Boolean} [absolute=false] False for a path relative to
+        this book's content root
+    @return {String}
+*/
+Book.prototype.getDefaultGlossaryPath = function(absolute) {
+    var defaultPath = 'GLOSSARY'+this.getDefaultExt();
+    if (absolute) {
+        return path.join(this.getContentRoot(), defaultPath);
+    } else {
+        return defaultPath;
+    }
+};
+
 /**
     Create a language book from a parent
 
@@ -253,12 +345,16 @@ Book.createForFS = function createForFS(fs) {
 */
 Book.createFromParent = function createFromParent(parent, language) {
     var ignore = parent.getIgnore();
+    var config = parent.getConfig();
+
+    // Set language in configuration
+    config = config.setValue('language', language);
 
     return new Book({
         // Inherits config. logegr and list of ignored files
         logger: parent.getLogger(),
-        config: parent.getConfig(),
-        ignore: Ignore().add(ignore),
+        config: config,
+        ignore: ignore,
 
         language: language,
         fs: FS.reduceScope(parent.getContentFS(), language)

lib/models/config.js

@@ -2,6 +2,7 @@ var is = require('is');
 var Immutable = require('immutable');
 
 var File = require('./file');
+var PluginDependency = require('./pluginDependency');
 var configDefault = require('../constants/configDefault');
 
 var Config = Immutable.Record({
@@ -18,11 +19,27 @@ Config.prototype.getValues = function() {
 };
 
 /**
-    Return a configuration value by its key path
+ * Render config as text
+ * @return {Promise<String>}
+ */
+Config.prototype.toText = function() {
+    return JSON.stringify(this.getValues().toJS(), null, 4);
+};
 
-    @param {String} key
-    @return {Mixed}
-*/
+/**
+ * Change the file for the configuration
+ * @param {File} file
+ * @return {Config}
+ */
+Config.prototype.setFile = function(file) {
+    return this.set('file', file);
+};
+
+/**
+ * Return a configuration value by its key path
+ * @param {String} key
+ * @return {Mixed}
+ */
 Config.prototype.getValue = function(keyPath, def) {
     var values = this.getValues();
     keyPath = Config.keyToKeyPath(keyPath);
@@ -35,12 +52,11 @@ Config.prototype.getValue = function(keyPath, def) {
 };
 
 /**
-    Update a configuration value
-
-    @param {String} key
-    @param {Mixed} value
-    @return {Mixed}
-*/
+ * Update a configuration value
+ * @param {String} key
+ * @param {Mixed} value
+ * @return {Config}
+ */
 Config.prototype.setValue = function(keyPath, value) {
     keyPath = Config.keyToKeyPath(keyPath);
 
@@ -53,12 +69,76 @@ Config.prototype.setValue = function(keyPath, value) {
 };
 
 /**
-    Create a new config for a file
+ * Return a list of plugin dependencies
+ * @return {List<PluginDependency>}
+ */
+Config.prototype.getPluginDependencies = function() {
+    var plugins = this.getValue('plugins');
 
-    @param {File} file
-    @param {Object} values
-    @returns {Config}
-*/
+    if (is.string(plugins)) {
+        return PluginDependency.listFromString(plugins);
+    } else {
+        return PluginDependency.listFromArray(plugins);
+    }
+};
+
+/**
+ * Return a plugin dependency by its name
+ * @param {String} name
+ * @return {PluginDependency}
+ */
+Config.prototype.getPluginDependency = function(name) {
+    var plugins = this.getPluginDependencies();
+
+    return plugins.find(function(dep) {
+        return dep.getName() === name;
+    });
+};
+
+/**
+ * Update the list of plugins dependencies
+ * @param {List<PluginDependency>}
+ * @return {Config}
+ */
+Config.prototype.setPluginDependencies = function(deps) {
+    var plugins = PluginDependency.listToArray(deps);
+
+    return this.setValue('plugins', plugins);
+};
+
+
+/**
+ * Update values for an existing configuration
+ * @param {Object} values
+ * @returns {Config}
+ */
+Config.prototype.updateValues = function(values) {
+    values = Immutable.fromJS(values);
+
+    return this.set('values', values);
+};
+
+/**
+ * Update values for an existing configuration
+ * @param {Config} config
+ * @param {Object} values
+ * @returns {Config}
+ */
+Config.prototype.mergeValues = function(values) {
+    var currentValues = this.getValues();
+    values = Immutable.fromJS(values);
+
+    currentValues = currentValues.mergeDeep(values);
+
+    return this.set('values', currentValues);
+};
+
+/**
+ * Create a new config for a file
+ * @param {File} file
+ * @param {Object} values
+ * @returns {Config}
+ */
 Config.create = function(file, values) {
     return new Config({
         file: file,
@@ -67,37 +147,22 @@ Config.create = function(file, values) {
 };
 
 /**
-    Create a new config
-
-    @param {Object} values
-    @returns {Config}
-*/
+ * Create a new config
+ * @param {Object} values
+ * @returns {Config}
+ */
 Config.createWithValues = function(values) {
     return new Config({
         values: Immutable.fromJS(values)
     });
 };
 
-/**
-    Update values for an existing configuration
-
-    @param {Config} config
-    @param {Object} values
-    @returns {Config}
-*/
-Config.updateValues = function(config, values) {
-    values = Immutable.fromJS(values);
-
-    return config.set('values', values);
-};
-
 
 /**
-    Convert a keyPath to an array of keys
-
-    @param {String|Array}
-    @return {Array}
-*/
+ * Convert a keyPath to an array of keys
+ * @param {String|Array}
+ * @return {Array}
+ */
 Config.keyToKeyPath = function(keyPath) {
     if (is.string(keyPath)) keyPath = keyPath.split('.');
     return keyPath;

lib/models/fs.js

@@ -1,5 +1,6 @@
 var path = require('path');
 var Immutable = require('immutable');
+var stream = require('stream');
 
 var File = require('./file');
 var Promise = require('../utils/promise');
@@ -13,7 +14,9 @@ var FS = Immutable.Record({
     fsReadFile:       Function(),
     fsStatFile:       Function(),
     fsReadDir:        Function(),
-    fsLoadObject:     null
+
+    fsLoadObject:     null,
+    fsReadAsStream:   null
 });
 
 /**
@@ -111,6 +114,30 @@ FS.prototype.readAsString = function(filename, encoding) {
     });
 };
 
+/**
+    Read file as a stream
+
+    @param {String} filename
+    @return {Promise<Stream>}
+*/
+FS.prototype.readAsStream = function(filename) {
+    var that = this;
+    var filepath = that.resolve(filename);
+    var fsReadAsStream = this.get('fsReadAsStream');
+
+    if (fsReadAsStream) {
+        return Promise(fsReadAsStream(filepath));
+    }
+
+    return this.read(filename)
+    .then(function(buf) {
+        var bufferStream = new stream.PassThrough();
+        bufferStream.end(buf);
+
+        return bufferStream;
+    });
+};
+
 /**
     Read stat infos about a file
 
@@ -171,23 +198,29 @@ FS.prototype.listFiles = function(dirname) {
 /**
     List all files in a directory
 
-    @param {String} dirname
+    @param {String} dirName
+    @param {Function(dirName)} filterFn: call it for each file/directory to test if it should stop iterating
     @return {Promise<List<String>>}
 */
-FS.prototype.listAllFiles = function(folder) {
+FS.prototype.listAllFiles = function(dirName, filterFn) {
     var that = this;
-    folder = folder || '.';
+    dirName = dirName || '.';
 
-    return this.readDir(folder)
+    return this.readDir(dirName)
     .then(function(files) {
         return Promise.reduce(files, function(out, file) {
             var isDirectory = pathIsFolder(file);
+            var newDirName = path.join(dirName, file);
 
-            if (!isDirectory) {
-                return out.push(path.join(folder, file));
+            if (filterFn && filterFn(newDirName) === false) {
+                return out;
             }
 
-            return that.listAllFiles(path.join(folder, file))
+            if (!isDirectory) {
+                return out.push(newDirName);
+            }
+
+            return that.listAllFiles(newDirName, filterFn)
             .then(function(inner) {
                 return out.concat(inner);
             });
@@ -196,7 +229,7 @@ FS.prototype.listAllFiles = function(folder) {
 };
 
 /**
-    Find a file in a folder (case incensitive)
+    Find a file in a folder (case insensitive)
     Return the found filename
 
     @param {String} dirname

lib/models/ignore.js

@@ -0,0 +1,42 @@
+var Immutable = require('immutable');
+var IgnoreMutable = require('ignore');
+
+/*
+    Immutable version of node-ignore
+*/
+var Ignore = Immutable.Record({
+    ignore: new IgnoreMutable()
+}, 'Ignore');
+
+Ignore.prototype.getIgnore = function() {
+    return this.get('ignore');
+};
+
+/**
+    Test if a file is ignored by these rules
+
+    @param {String} filePath
+    @return {Boolean}
+*/
+Ignore.prototype.isFileIgnored = function(filename) {
+    var ignore = this.getIgnore();
+    return ignore.filter([filename]).length == 0;
+};
+
+/**
+    Add rules
+
+    @param {String}
+    @return {Ignore}
+*/
+Ignore.prototype.add = function(rule) {
+    var ignore = this.getIgnore();
+    var newIgnore = new IgnoreMutable();
+
+    newIgnore.add(ignore);
+    newIgnore.add(rule);
+
+    return this.set('ignore', newIgnore);
+};
+
+module.exports = Ignore;

lib/models/languages.js

@@ -57,7 +57,7 @@ Languages.createFromList = function(file, langs) {
     langs.forEach(function(lang) {
         lang = Language({
             title: lang.title,
-            path: lang.path
+            path: lang.ref
         });
         list = list.set(lang.getID(), lang);
     });

lib/models/output.js

@@ -1,6 +1,7 @@
 var Immutable = require('immutable');
 
 var Book = require('./book');
+var LocationUtils = require('../utils/location');
 
 var Output = Immutable.Record({
     book:       Book(),
@@ -52,6 +53,19 @@ Output.prototype.getState = function() {
     return this.get('state');
 };
 
+/**
+    Return a page byt its file path
+
+    @param {String} filePath
+    @return {Page|undefined}
+*/
+Output.prototype.getPage = function(filePath) {
+    filePath = LocationUtils.normalize(filePath);
+
+    var pages = this.getPages();
+    return pages.get(filePath);
+};
+
 /**
     Get root folder for output
 

lib/models/parser.js

@@ -43,6 +43,10 @@ Parser.prototype.parseGlossary = function(content) {
 
 Parser.prototype.preparePage = function(content) {
     var page = this.get('page');
+    if (!page.prepare) {
+        return Promise(content);
+    }
+
     return Promise(page.prepare(content));
 };
 
@@ -51,6 +55,11 @@ Parser.prototype.parsePage = function(content) {
     return Promise(page(content));
 };
 
+Parser.prototype.parseInline = function(content) {
+    var inline = this.get('inline');
+    return Promise(inline(content));
+};
+
 Parser.prototype.parseLanguages = function(content) {
     var langs = this.get('langs');
     return Promise(langs(content));

lib/models/plugin.js

@@ -1,9 +1,10 @@
 var Immutable = require('immutable');
 
 var TemplateBlock = require('./templateBlock');
-var PREFIX = require('../constants/pluginPrefix');
 var DEFAULT_VERSION = '*';
 
+var PluginDependency = require('./pluginDependency');
+
 var Plugin = Immutable.Record({
     name:       String(),
 
@@ -53,7 +54,7 @@ Plugin.prototype.getDepth = function() {
     @return {String}
 */
 Plugin.prototype.getNpmID = function() {
-    return Plugin.nameToNpmID(this.getName());
+    return PluginDependency.nameToNpmID(this.getName());
 };
 
 /**
@@ -140,13 +141,18 @@ Plugin.createFromString = function(s) {
 };
 
 /**
-    Return NPM id for a plugin name
+    Create a plugin from a dependency
 
-    @param {String}
-    @return {String}
+    @param {PluginDependency}
+    @return {Plugin}
 */
-Plugin.nameToNpmID = function(s) {
-    return PREFIX + s;
+Plugin.createFromDep = function(dep) {
+    return new Plugin({
+        name: dep.getName(),
+        version: dep.getVersion()
+    });
 };
 
+Plugin.nameToNpmID = PluginDependency.nameToNpmID;
+
 module.exports = Plugin;

lib/models/pluginDependency.js

@@ -0,0 +1,168 @@
+var is = require('is');
+var semver = require('semver');
+var Immutable = require('immutable');
+
+var PREFIX = require('../constants/pluginPrefix');
+var DEFAULT_VERSION = '*';
+
+/*
+ * PluginDependency represents the informations about a plugin
+ * stored in config.plugins
+ */
+var PluginDependency = Immutable.Record({
+    name:       String(),
+
+    // Requirement version (ex: ">1.0.0")
+    version:    String(DEFAULT_VERSION),
+
+    // Is this plugin enabled or disabled?
+    enabled:    Boolean(true)
+}, 'PluginDependency');
+
+PluginDependency.prototype.getName = function() {
+    return this.get('name');
+};
+
+PluginDependency.prototype.getVersion = function() {
+    return this.get('version');
+};
+
+PluginDependency.prototype.isEnabled = function() {
+    return this.get('enabled');
+};
+
+/**
+ * Toggle this plugin state
+ * @param  {Boolean}
+ * @return {PluginDependency}
+ */
+PluginDependency.prototype.toggle = function(state) {
+    if (is.undef(state)) {
+        state = !this.isEnabled();
+    }
+
+    return this.set('enabled', state);
+};
+
+/**
+ * Return NPM ID for the dependency
+ * @return {String}
+ */
+PluginDependency.prototype.getNpmID = function() {
+    return PluginDependency.nameToNpmID(this.getName());
+};
+
+/**
+ * Is the plugin using a git dependency
+ * @return {Boolean}
+ */
+PluginDependency.prototype.isGitDependency = function() {
+    return !semver.validRange(this.getVersion());
+};
+
+/**
+ * Create a plugin with a name and a plugin
+ * @param {String}
+ * @return {Plugin|undefined}
+ */
+PluginDependency.create = function(name, version, enabled) {
+    if (is.undefined(enabled)) {
+        enabled = true;
+    }
+
+    return new PluginDependency({
+        name: name,
+        version: version || DEFAULT_VERSION,
+        enabled: Boolean(enabled)
+    });
+};
+
+/**
+ * Create a plugin from a string
+ * @param {String}
+ * @return {Plugin|undefined}
+ */
+PluginDependency.createFromString = function(s) {
+    var parts = s.split('@');
+    var name = parts[0];
+    var version = parts.slice(1).join('@');
+    var enabled = true;
+
+    if (name[0] === '-') {
+        enabled = false;
+        name = name.slice(1);
+    }
+
+    return new PluginDependency({
+        name: name,
+        version: version || DEFAULT_VERSION,
+        enabled: enabled
+    });
+};
+
+/**
+ * Create a PluginDependency from a string
+ * @param {String}
+ * @return {List<PluginDependency>}
+ */
+PluginDependency.listFromString = function(s) {
+    var parts = s.split(',');
+    return PluginDependency.listFromArray(parts);
+};
+
+/**
+ * Create a PluginDependency from an array
+ * @param {Array}
+ * @return {List<PluginDependency>}
+ */
+PluginDependency.listFromArray = function(arr) {
+    return Immutable.List(arr)
+        .map(function(entry) {
+            if (is.string(entry)) {
+                return PluginDependency.createFromString(entry);
+            } else {
+                return PluginDependency({
+                    name: entry.get('name'),
+                    version: entry.get('version')
+                });
+            }
+        })
+        .filter(function(dep) {
+            return Boolean(dep.getName());
+        });
+};
+
+/**
+ * Export plugin dependencies as an array
+ * @param {List<PluginDependency>} list
+ * @return {Array<String>}
+ */
+PluginDependency.listToArray = function(list) {
+    return list
+        .map(function(dep) {
+            var result = '';
+
+            if (!dep.isEnabled()) {
+                result += '-';
+            }
+
+            result += dep.getName();
+            if (dep.getVersion() !== DEFAULT_VERSION) {
+                result += '@' + dep.getVersion();
+            }
+
+            return result;
+        })
+        .toJS();
+};
+
+/**
+ * Return NPM id for a plugin name
+ * @param {String}
+ * @return {String}
+ */
+PluginDependency.nameToNpmID = function(s) {
+    return PREFIX + s;
+};
+
+module.exports = PluginDependency;

lib/models/summary.js

@@ -56,7 +56,7 @@ Summary.prototype.getArticle = function(iter, partIter) {
     Return a part/article by its level
 
     @param {String} level
-    @return {Article}
+    @return {Article|Part}
 */
 Summary.prototype.getByLevel = function(level) {
     function iterByLevel(article) {
@@ -74,7 +74,12 @@ Summary.prototype.getByLevel = function(level) {
 */
 Summary.prototype.getByPath = function(filePath) {
     return this.getArticle(function(article) {
-        return (LocationUtils.areIdenticalPaths(article.getPath(), filePath));
+        var articlePath = article.getPath();
+
+        return (
+            articlePath &&
+            LocationUtils.areIdenticalPaths(articlePath, filePath)
+        );
     });
 };
 
@@ -129,6 +134,27 @@ Summary.prototype.getPrevArticle = function(current) {
     return prev;
 };
 
+/**
+    Return the parent article, or parent part of an article
+
+    @param {String|Article} current
+    @return {Article|Part|Null}
+*/
+Summary.prototype.getParent = function (level) {
+    // Coerce to level
+    level = is.string(level)? level : level.getLevel();
+
+    // Get parent level
+    var parentLevel = getParentLevel(level);
+    if (!parentLevel) {
+        return null;
+    }
+
+    // Get parent of the position
+    var parentArticle = this.getByLevel(parentLevel);
+    return parentArticle || null;
+};
+
 /**
     Render summary as text
 
@@ -188,4 +214,15 @@ Summary.createFromParts = function createFromParts(file, parts) {
     });
 };
 
+/**
+    Returns parent level of a level
+
+    @param {String} level
+    @return {String}
+*/
+function getParentLevel(level) {
+    var parts = level.split('.');
+    return parts.slice(0, -1).join('.');
+}
+
 module.exports = Summary;

lib/models/summaryArticle.js

@@ -30,12 +30,13 @@ SummaryArticle.prototype.getArticles = function() {
 };
 
 /**
-    Return how deep the article is
+    Return how deep the article is.
+    The README has a depth of 1
 
     @return {Number}
 */
 SummaryArticle.prototype.getDepth = function() {
-    return this.getLevel().split('.').length;
+    return (this.getLevel().split('.').length - 1);
 };
 
 /**
@@ -53,7 +54,6 @@ SummaryArticle.prototype.getPath = function() {
         return undefined;
     }
 
-
     var parts = ref.split('#');
 
     var pathname = (parts.length > 1? parts.slice(0, -1).join('#') : ref);

lib/models/templateBlock.js

@@ -4,11 +4,10 @@ var Immutable = require('immutable');
 
 var Promise = require('../utils/promise');
 var genKey = require('../utils/genKey');
+var TemplateShortcut = require('./templateShortcut');
 
 var NODE_ENDARGS = '%%endargs%%';
 
-var blockBodies = {};
-
 var TemplateBlock = Immutable.Record({
     // Name of block, also the start tag
     name:           String(),
@@ -23,26 +22,13 @@ var TemplateBlock = Immutable.Record({
     blocks:         Immutable.List(),
 
     // List of shortcuts to replace with this block
-    shortcuts:      Immutable.List(),
-
-    // Function to execute in post processing
-    post:           null,
-
-    parse:          true
+    shortcuts:      Immutable.Map()
 }, 'TemplateBlock');
 
 TemplateBlock.prototype.getName = function() {
     return this.get('name');
 };
 
-TemplateBlock.prototype.getPost = function() {
-    return this.get('post');
-};
-
-TemplateBlock.prototype.getParse = function() {
-    return this.get('parse');
-};
-
 TemplateBlock.prototype.getEndTag = function() {
     return this.get('end') || ('end' + this.getName());
 };
@@ -55,25 +41,35 @@ TemplateBlock.prototype.getBlocks = function() {
     return this.get('blocks');
 };
 
+
+/**
+ * Return shortcuts associated with this block or undefined
+ * @return {TemplateShortcut|undefined}
+ */
 TemplateBlock.prototype.getShortcuts = function() {
-    return this.get('shortcuts');
+    var shortcuts = this.get('shortcuts');
+    if (shortcuts.size === 0) {
+        return undefined;
+    }
+
+    return TemplateShortcut.createForBlock(this, shortcuts);
 };
 
 /**
-    Return name for the nunjucks extension
-
-    @return {String}
-*/
+ * Return name for the nunjucks extension
+ * @return {String}
+ */
 TemplateBlock.prototype.getExtensionName = function() {
     return 'Block' + this.getName() + 'Extension';
 };
 
 /**
-    Return a nunjucks extension to represents this block
+ * Return a nunjucks extension to represents this block
+ * @return {Nunjucks.Extension}
+ */
+TemplateBlock.prototype.toNunjucksExt = function(mainContext, blocksOutput) {
+    blocksOutput = blocksOutput || {};
 
-    @return {Nunjucks.Extension}
-*/
-TemplateBlock.prototype.toNunjucksExt = function(mainContext) {
     var that = this;
     var name = this.getName();
     var endTag = this.getEndTag();
@@ -183,7 +179,7 @@ TemplateBlock.prototype.toNunjucksExt = function(mainContext) {
                 return that.applyBlock(mainBlock, ctx);
             })
             .then(function(result) {
-                return that.blockResultToHtml(result);
+                return that.blockResultToHtml(result, blocksOutput);
             })
             .nodeify(callback);
         };
@@ -193,11 +189,11 @@ TemplateBlock.prototype.toNunjucksExt = function(mainContext) {
 };
 
 /**
-    Apply a block to a content
-    @param {Object} inner
-    @param {Object} context
-    @return {Promise<String>|String}
-*/
+ * Apply a block to a content
+ * @param {Object} inner
+ * @param {Object} context
+ * @return {Promise<String>|String}
+ */
 TemplateBlock.prototype.applyBlock = function(inner, context) {
     var processFn = this.getProcess();
 
@@ -209,19 +205,18 @@ TemplateBlock.prototype.applyBlock = function(inner, context) {
     var r = processFn.call(context, inner);
 
     if (Promise.isPromiseAlike(r)) {
-        return r.then(this.handleBlockResult.bind(this));
+        return r.then(this.normalizeBlockResult.bind(this));
     } else {
-        return this.handleBlockResult(r);
+        return this.normalizeBlockResult(r);
     }
 };
 
 /**
-    Handle result from a block process function
-
-    @param {Object} result
-    @return {Object}
-*/
-TemplateBlock.prototype.handleBlockResult = function(result) {
+ * Normalize result from a block process function
+ * @param {Object|String} result
+ * @return {Object}
+ */
+TemplateBlock.prototype.normalizeBlockResult = function(result) {
     if (is.string(result)) {
         result = { body: result };
     }
@@ -231,22 +226,22 @@ TemplateBlock.prototype.handleBlockResult = function(result) {
 };
 
 /**
-    Convert a block result to HTML
-
-    @param {Object} result
-    @return {String}
-*/
-TemplateBlock.prototype.blockResultToHtml = function(result) {
-    var parse = this.getParse();
+ * Convert a block result to HTML
+ * @param {Object} result
+ * @param {Object} blocksOutput: stored post processing blocks in this object
+ * @return {String}
+ */
+TemplateBlock.prototype.blockResultToHtml = function(result, blocksOutput) {
     var indexedKey;
-    var toIndex = (!parse) || (this.getPost() !== undefined);
+    var toIndex = (!result.parse) || (result.post !== undefined);
 
     if (toIndex) {
-        indexedKey = TemplateBlock.indexBlockResult(result);
+        indexedKey = genKey();
+        blocksOutput[indexedKey] = result;
     }
 
     // Parsable block, just return it
-    if (parse) {
+    if (result.parse) {
         return result.body;
     }
 
@@ -256,35 +251,11 @@ TemplateBlock.prototype.blockResultToHtml = function(result) {
 };
 
 /**
-    Index a block result, and return the indexed key
-
-    @param {Object} blk
-    @return {String}
-*/
-TemplateBlock.indexBlockResult = function(blk) {
-    var key = genKey();
-    blockBodies[key] = blk;
-
-    return key;
-};
-
-/**
-    Get a block results indexed for a specific key
-
-    @param {String} key
-    @return {Object|undefined}
-*/
-TemplateBlock.getBlockResultByKey = function(key) {
-    return blockBodies[key];
-};
-
-/**
-    Create a template block from a function or an object
-
-    @param {String} blockName
-    @param {Object} block
-    @return {TemplateBlock}
-*/
+ * Create a template block from a function or an object
+ * @param {String} blockName
+ * @param {Object} block
+ * @return {TemplateBlock}
+ */
 TemplateBlock.create = function(blockName, block) {
     if (is.fn(block)) {
         block = new Immutable.Map({
@@ -292,16 +263,16 @@ TemplateBlock.create = function(blockName, block) {
         });
     }
 
+    block = new TemplateBlock(block);
     block = block.set('name', blockName);
-    return new TemplateBlock(block);
+    return block;
 };
 
 /**
-    Extract kwargs from an arguments array
-
-    @param {Array} args
-    @return {Object}
-*/
+ * Extract kwargs from an arguments array
+ * @param {Array} args
+ * @return {Object}
+ */
 function extractKwargs(args) {
     var last = args[args.length - 1];
     return (is.object(last) && last.__keywords)? args.pop() : {};

lib/models/templateEngine.js

@@ -67,7 +67,7 @@ TemplateEngine.prototype.getBlock = function(name) {
 
     @return {Nunjucks.Environment}
 */
-TemplateEngine.prototype.toNunjucks = function() {
+TemplateEngine.prototype.toNunjucks = function(blocksOutput) {
     var loader = this.getLoader();
     var blocks = this.getBlocks();
     var filters = this.getFilters();
@@ -101,7 +101,7 @@ TemplateEngine.prototype.toNunjucks = function() {
     // Add blocks
     blocks.forEach(function(block) {
         var extName = block.getExtensionName();
-        var Ext = block.toNunjucksExt(context);
+        var Ext = block.toNunjucksExt(context, blocksOutput);
 
         env.addExtension(extName, new Ext());
     });

lib/models/templateOutput.js

@@ -0,0 +1,42 @@
+var Immutable = require('immutable');
+
+var TemplateOutput = Immutable.Record({
+    // Text content of the template
+    content:        String(),
+
+    // Map of blocks to replace / post process
+    blocks:         Immutable.Map()
+}, 'TemplateOutput');
+
+TemplateOutput.prototype.getContent = function() {
+    return this.get('content');
+};
+
+TemplateOutput.prototype.getBlocks = function() {
+    return this.get('blocks');
+};
+
+/**
+ * Update content of this output
+ * @param {String} content
+ * @return {TemplateContent}
+ */
+TemplateOutput.prototype.setContent = function(content) {
+    return this.set('content', content);
+};
+
+/**
+ * Create a TemplateOutput from a text content
+ * and an object containing block definition
+ * @param {String} content
+ * @param {Object} blocks
+ * @return {TemplateOutput}
+ */
+TemplateOutput.create = function(content, blocks) {
+    return new TemplateOutput({
+        content:    content,
+        blocks:     Immutable.fromJS(blocks)
+    });
+};
+
+module.exports = TemplateOutput;

lib/models/templateShortcut.js

@@ -0,0 +1,73 @@
+var Immutable = require('immutable');
+var is = require('is');
+
+/*
+    A TemplateShortcut is defined in plugin's template blocks
+    to replace content with a templating block using delimiters.
+*/
+var TemplateShortcut = Immutable.Record({
+    // List of parser names accepting this shortcut
+    parsers:     Immutable.Map(),
+
+    start:       String(),
+    end:         String(),
+
+    startTag:    String(),
+    endTag:      String()
+}, 'TemplateShortcut');
+
+TemplateShortcut.prototype.getStart = function() {
+    return this.get('start');
+};
+
+TemplateShortcut.prototype.getEnd = function() {
+    return this.get('end');
+};
+
+TemplateShortcut.prototype.getStartTag = function() {
+    return this.get('startTag');
+};
+
+TemplateShortcut.prototype.getEndTag = function() {
+    return this.get('endTag');
+};
+
+TemplateShortcut.prototype.getParsers = function() {
+    return this.get('parsers');
+};
+
+/**
+    Test if this shortcut accept a parser
+
+    @param {Parser|String} parser
+    @return {Boolean}
+*/
+TemplateShortcut.prototype.acceptParser = function(parser) {
+    if (!is.string(parser)) {
+        parser = parser.getName();
+    }
+
+    var parserNames = this.get('parsers');
+    return parserNames.includes(parser);
+};
+
+/**
+    Create a shortcut for a block
+
+    @param {TemplateBlock} block
+    @param {Map} details
+    @return {TemplateShortcut}
+*/
+TemplateShortcut.createForBlock = function(block, details) {
+    details = Immutable.fromJS(details);
+
+    return new TemplateShortcut({
+        parsers:        details.get('parsers'),
+        start:          details.get('start'),
+        end:            details.get('end'),
+        startTag:       block.getName(),
+        endTag:         block.getEndTag()
+    });
+};
+
+module.exports = TemplateShortcut;

lib/modifiers/config/__tests__/addPlugin.js

@@ -0,0 +1,35 @@
+var addPlugin = require('../addPlugin');
+var Config = require('../../../models/config');
+var Book = require('../../../models/book');
+
+describe('addPlugin', function() {
+    var config = Config.createWithValues({
+        plugins: ['hello', 'world', '-disabled']
+    });
+    var book = Book().setConfig(config);
+
+    it('should have correct state of dependencies', function() {
+        var disabledDep = config.getPluginDependency('disabled');
+
+        expect(disabledDep).toBeDefined();
+        expect(disabledDep.getVersion()).toEqual('*');
+        expect(disabledDep.isEnabled()).toBeFalsy();
+    });
+
+    it('should add the plugin to the list', function() {
+        var newBook = addPlugin(book, 'test');
+        var newConfig = newBook.getConfig();
+
+        var testDep = newConfig.getPluginDependency('test');
+        expect(testDep).toBeDefined();
+        expect(testDep.getVersion()).toEqual('*');
+        expect(testDep.isEnabled()).toBeTruthy();
+
+        var disabledDep = newConfig.getPluginDependency('disabled');
+        expect(disabledDep).toBeDefined();
+        expect(disabledDep.getVersion()).toEqual('*');
+        expect(disabledDep.isEnabled()).toBeFalsy();
+    });
+});
+
+

lib/modifiers/config/__tests__/togglePlugin.js

@@ -0,0 +1,32 @@
+var togglePlugin = require('../togglePlugin');
+var Config = require('../../../models/config');
+var Book = require('../../../models/book');
+
+describe('togglePlugin', function() {
+    var config = Config.createWithValues({
+        plugins: ['hello', 'world', '-disabled']
+    });
+    var book = Book().setConfig(config);
+
+    it('should enable plugin', function() {
+        var newBook = togglePlugin(book, 'disabled');
+        var newConfig = newBook.getConfig();
+
+        var testDep = newConfig.getPluginDependency('disabled');
+        expect(testDep).toBeDefined();
+        expect(testDep.getVersion()).toEqual('*');
+        expect(testDep.isEnabled()).toBeTruthy();
+    });
+
+    it('should disable plugin', function() {
+        var newBook = togglePlugin(book, 'world');
+        var newConfig = newBook.getConfig();
+
+        var testDep = newConfig.getPluginDependency('world');
+        expect(testDep).toBeDefined();
+        expect(testDep.getVersion()).toEqual('*');
+        expect(testDep.isEnabled()).toBeFalsy();
+    });
+});
+
+

lib/modifiers/config/addPlugin.js

@@ -1,18 +1,20 @@
+var PluginDependency = require('../../models/pluginDependency');
 
 /**
-    Add a plugin to a book's configuration
-
-    @param {Book} book
-    @param {String} plugin
-    @param {String} version (optional)
-    @return {Book}
-*/
+ * Add a plugin to a book's configuration
+ * @param {Book} book
+ * @param {String} plugin
+ * @param {String} version (optional)
+ * @return {Book}
+ */
 function addPlugin(book, plugin, version) {
     var config = book.getConfig();
-    var plugins = config.getValue('plugins', []);
+    var deps = config.getPluginDependencies();
 
-    plugins = plugins.push('livereload');
-    config = config.setValue('plugins', plugins);
+    var dep = PluginDependency.create(plugin, version);
+
+    deps = deps.push(dep);
+    config = config.setPluginDependencies(deps);
 
     return book.setConfig(config);
 }

lib/modifiers/config/editPlugin.js

@@ -0,0 +1,16 @@
+
+/**
+ * Edit ocnfiguration of a plugin
+ * @param {Book} book
+ * @param {String} plugin
+ * @param {Object} pluginConfig
+ * @return {Book}
+ */
+function editPlugin(book, pluginName, pluginConfig) {
+    var config = book.getConfig();
+    config = config.set('pluginsConfig.'+pluginName, pluginConfig);
+
+    return book.setConfig(config);
+}
+
+module.exports = editPlugin;

lib/modifiers/config/index.js

@@ -1,5 +1,7 @@
 
 module.exports = {
-    addPlugin:          require('./addPlugin'),
-    removePlugin:       require('./removePlugin')
+    addPlugin:    require('./addPlugin'),
+    removePlugin: require('./removePlugin'),
+    togglePlugin: require('./togglePlugin'),
+    editPlugin:   require('./editPlugin')
 };

lib/modifiers/config/removePlugin.js

@@ -1,22 +1,19 @@
 
 /**
-    Remove a plugin from a book's configuration
-
-    @param {Book} book
-    @param {String} plugin
-    @return {Book}
-*/
+ * Remove a plugin from a book's configuration
+ * @param {Book} book
+ * @param {String} plugin
+ * @return {Book}
+ */
 function removePlugin(book, pluginName) {
     var config = book.getConfig();
-    var plugins = config.getValue('plugins', []);
+    var deps = config.getPluginDependencies();
 
-    // Find index of this plugin
-    var index = plugins.findIndex(function(plugin) {
-        return plugin === pluginName;
+
+    deps = deps.filter(function(dep) {
+        return dep.getName() === pluginName;
     });
-
-    plugins = plugins.delete(index);
-    config = config.setValue('plugins', plugins);
+    config = config.setPluginDependencies(deps);
 
     return book.setConfig(config);
 }

lib/modifiers/config/togglePlugin.js

@@ -0,0 +1,25 @@
+
+/**
+ * Enable/disable a plugin dependency
+ * @param {Book} book
+ * @param {String} plugin
+ * @param {Boolean} state (optional)
+ * @return {Book}
+ */
+function togglePlugin(book, plugin, state) {
+    var config = book.getConfig();
+    var deps = config.getPluginDependencies();
+
+    deps = deps.map(function(dep) {
+        if (dep.getName() === plugin) {
+            return dep.toggle(state);
+        }
+
+        return dep;
+    });
+
+    config = config.setPluginDependencies(deps);
+    return book.setConfig(config);
+}
+
+module.exports = togglePlugin;

lib/modifiers/summary/__tests__/insertArticle.js

@@ -0,0 +1,78 @@
+var Summary = require('../../../models/summary');
+var SummaryArticle = require('../../../models/summaryArticle');
+var File = require('../../../models/file');
+
+describe('insertArticle', function() {
+    var insertArticle = require('../insertArticle');
+    var summary = Summary.createFromParts(File(), [
+        {
+            articles: [
+                {
+                    title: '1.1',
+                    path: '1.1'
+                },
+                {
+                    title: '1.2',
+                    path: '1.2'
+                }
+            ]
+        },
+        {
+            title: 'Part I',
+            articles: [
+                {
+                    title: '2.1',
+                    path: '2.1',
+                    articles: [
+                        {
+                            title: '2.1.1',
+                            path: '2.1.1'
+                        },
+                        {
+                            title: '2.1.2',
+                            path: '2.1.2'
+                        }
+                    ]
+                },
+                {
+                    title: '2.2',
+                    path: '2.2'
+                }
+            ]
+        }
+    ]);
+
+    it('should insert an article at a given level', function() {
+        var article = SummaryArticle.create({
+            title: 'Inserted'
+        }, 'fake.level');
+
+        var newSummary = insertArticle(summary, article, '2.1.1');
+
+        var inserted = newSummary.getByLevel('2.1.1');
+        var nextOne = newSummary.getByLevel('2.1.2');
+
+        expect(inserted.getTitle()).toBe('Inserted');
+        expect(inserted.getLevel()).toBe('2.1.1');
+
+        expect(nextOne.getTitle()).toBe('2.1.1');
+        expect(nextOne.getLevel()).toBe('2.1.2');
+    });
+
+    it('should insert an article in last position', function() {
+        var article = SummaryArticle.create({
+            title: 'Inserted'
+        }, 'fake.level');
+
+        var newSummary = insertArticle(summary, article, '2.2');
+
+        var inserted = newSummary.getByLevel('2.2');
+        var previousOne = newSummary.getByLevel('2.1');
+
+        expect(inserted.getTitle()).toBe('Inserted');
+        expect(inserted.getLevel()).toBe('2.2');
+
+        expect(previousOne.getTitle()).toBe('2.1'); // Unchanged
+        expect(previousOne.getLevel()).toBe('2.1');
+    });
+});

lib/modifiers/summary/__tests__/mergeAtLevel.js

@@ -0,0 +1,45 @@
+var Immutable = require('immutable');
+var Summary = require('../../../models/summary');
+var File = require('../../../models/file');
+
+describe('mergeAtLevel', function() {
+    var mergeAtLevel = require('../mergeAtLevel');
+    var summary = Summary.createFromParts(File(), [
+        {
+            articles: [
+                {
+                    title: '1.1',
+                    path: '1.1'
+                },
+                {
+                    title: '1.2',
+                    path: '1.2'
+                }
+            ]
+        },
+        {
+            title: 'Part I',
+            articles: []
+        }
+    ]);
+
+    it('should edit a part', function() {
+        var beforeChildren = summary.getByLevel('1').getArticles();
+        var newSummary = mergeAtLevel(summary, '1', {title: 'Part O'});
+        var edited = newSummary.getByLevel('1');
+
+        expect(edited.getTitle()).toBe('Part O');
+        // Same children
+        expect(Immutable.is(beforeChildren, edited.getArticles())).toBe(true);
+    });
+
+    it('should edit a part', function() {
+        var beforePath = summary.getByLevel('1.2').getPath();
+        var newSummary = mergeAtLevel(summary, '1.2', {title: 'Renamed article'});
+        var edited = newSummary.getByLevel('1.2');
+
+        expect(edited.getTitle()).toBe('Renamed article');
+        // Same children
+        expect(Immutable.is(beforePath, edited.getPath())).toBe(true);
+    });
+});

lib/modifiers/summary/__tests__/moveArticle.js

@@ -0,0 +1,68 @@
+var Immutable = require('immutable');
+var Summary = require('../../../models/summary');
+var File = require('../../../models/file');
+
+describe('moveArticle', function() {
+    var moveArticle = require('../moveArticle');
+    var summary = Summary.createFromParts(File(), [
+        {
+            articles: [
+                {
+                    title: '1.1',
+                    path: '1.1'
+                },
+                {
+                    title: '1.2',
+                    path: '1.2'
+                }
+            ]
+        },
+        {
+            title: 'Part I',
+            articles: [
+                {
+                    title: '2.1',
+                    path: '2.1',
+                    articles: [
+                        {
+                            title: '2.1.1',
+                            path: '2.1.1'
+                        },
+                        {
+                            title: '2.1.2',
+                            path: '2.1.2'
+                        }
+                    ]
+                },
+                {
+                    title: '2.2',
+                    path: '2.2'
+                }
+            ]
+        }
+    ]);
+
+    it('should move an article to the same place', function() {
+        var newSummary = moveArticle(summary, '2.1', '2.1');
+
+        expect(Immutable.is(summary, newSummary)).toBe(true);
+    });
+
+    it('should move an article to an previous level', function() {
+        var newSummary = moveArticle(summary, '2.2', '2.1');
+        var moved = newSummary.getByLevel('2.1');
+        var other = newSummary.getByLevel('2.2');
+
+        expect(moved.getTitle()).toBe('2.2');
+        expect(other.getTitle()).toBe('2.1');
+    });
+
+    it('should move an article to a next level', function() {
+        var newSummary = moveArticle(summary, '2.1', '2.2');
+        var moved = newSummary.getByLevel('2.1');
+        var other = newSummary.getByLevel('2.2');
+
+        expect(moved.getTitle()).toBe('2.2');
+        expect(other.getTitle()).toBe('2.1');
+    });
+});

lib/modifiers/summary/__tests__/moveArticleAfter.js

@@ -0,0 +1,82 @@
+var Immutable = require('immutable');
+var Summary = require('../../../models/summary');
+var File = require('../../../models/file');
+
+describe('moveArticleAfter', function() {
+    var moveArticleAfter = require('../moveArticleAfter');
+    var summary = Summary.createFromParts(File(), [
+        {
+            articles: [
+                {
+                    title: '1.1',
+                    path: '1.1'
+                },
+                {
+                    title: '1.2',
+                    path: '1.2'
+                }
+            ]
+        },
+        {
+            title: 'Part I',
+            articles: [
+                {
+                    title: '2.1',
+                    path: '2.1',
+                    articles: [
+                        {
+                            title: '2.1.1',
+                            path: '2.1.1'
+                        },
+                        {
+                            title: '2.1.2',
+                            path: '2.1.2'
+                        }
+                    ]
+                },
+                {
+                    title: '2.2',
+                    path: '2.2'
+                }
+            ]
+        }
+    ]);
+
+    it('moving right after itself should be invariant', function() {
+        var newSummary = moveArticleAfter(summary, '2.1', '2.1');
+
+        expect(Immutable.is(summary, newSummary)).toBe(true);
+    });
+
+    it('moving after previous one should be invariant too', function() {
+        var newSummary = moveArticleAfter(summary, '2.1', '2.0');
+
+        expect(Immutable.is(summary, newSummary)).toBe(true);
+    });
+
+    it('should move an article after a previous level', function() {
+        var newSummary = moveArticleAfter(summary, '2.2', '2.0');
+        var moved = newSummary.getByLevel('2.1');
+
+        expect(moved.getTitle()).toBe('2.2');
+        expect(newSummary.getByLevel('2.2').getTitle()).toBe('2.1');
+    });
+
+    it('should move an article after a previous and less deep level', function() {
+        var newSummary = moveArticleAfter(summary, '2.1.1', '2.0');
+        var moved = newSummary.getByLevel('2.1');
+
+        expect(moved.getTitle()).toBe('2.1.1');
+        expect(newSummary.getByLevel('2.2.1').getTitle()).toBe('2.1.2');
+        expect(newSummary.getByLevel('2.2').getTitle()).toBe('2.1');
+    });
+
+    it('should move an article after a next level', function() {
+        var newSummary = moveArticleAfter(summary, '2.1', '2.2');
+        var moved = newSummary.getByLevel('2.2');
+
+        expect(moved.getTitle()).toBe('2.1');
+        expect(newSummary.getByLevel('2.1').getTitle()).toBe('2.2');
+    });
+
+});

lib/modifiers/summary/__tests__/removeArticle.js

@@ -0,0 +1,53 @@
+var Summary = require('../../../models/summary');
+var File = require('../../../models/file');
+
+describe('removeArticle', function() {
+    var removeArticle = require('../removeArticle');
+    var summary = Summary.createFromParts(File(), [
+        {
+            articles: [
+                {
+                    title: '1.1',
+                    path: '1.1'
+                },
+                {
+                    title: '1.2',
+                    path: '1.2'
+                }
+            ]
+        },
+        {
+            title: 'Part I',
+            articles: [
+                {
+                    title: '2.1',
+                    path: '2.1',
+                    articles: [
+                        {
+                            title: '2.1.1',
+                            path: '2.1.1'
+                        },
+                        {
+                            title: '2.1.2',
+                            path: '2.1.2'
+                        }
+                    ]
+                },
+                {
+                    title: '2.2',
+                    path: '2.2'
+                }
+            ]
+        }
+    ]);
+
+    it('should remove an article at a given level', function() {
+        var newSummary = removeArticle(summary, '2.1.1');
+
+        var removed = newSummary.getByLevel('2.1.1');
+        var nextOne = newSummary.getByLevel('2.1.2');
+
+        expect(removed.getTitle()).toBe('2.1.2');
+        expect(nextOne).toBe(null);
+    });
+});

lib/modifiers/summary/editArticleRef.js

@@ -0,0 +1,17 @@
+var mergeAtLevel = require('./mergeAtLevel');
+
+/**
+    Edit the ref of an article
+
+    @param {Summary} summary
+    @param {String} level
+    @param {String} newRef
+    @return {Summary}
+*/
+function editArticleRef(summary, level, newRef) {
+    return mergeAtLevel(summary, level, {
+        ref: newRef
+    });
+}
+
+module.exports = editArticleRef;

lib/modifiers/summary/editArticleTitle.js

@@ -1,4 +1,4 @@
-var editArticle = require('./editArticle');
+var mergeAtLevel = require('./mergeAtLevel');
 
 /**
     Edit title of an article
@@ -9,7 +9,7 @@ var editArticle = require('./editArticle');
     @return {Summary}
 */
 function editArticleTitle(summary, level, newTitle) {
-    return editArticle(summary, level, {
+    return mergeAtLevel(summary, level, {
         title: newTitle
     });
 }

lib/modifiers/summary/editPartTitle.js

@@ -1,4 +1,3 @@
-
 /**
     Edit title of a part in the summary
 

lib/modifiers/summary/index.js

@@ -1,8 +1,13 @@
-
 module.exports = {
     insertArticle:      require('./insertArticle'),
+    moveArticle:        require('./moveArticle'),
+    moveArticleAfter:   require('./moveArticleAfter'),
+    removeArticle:      require('./removeArticle'),
     unshiftArticle:     require('./unshiftArticle'),
+    editArticleTitle:   require('./editArticleTitle'),
+    editArticleRef:     require('./editArticleRef'),
 
-    editPartTitle:      require('./editPartTitle'),
-    editArticleTitle:   require('./editArticleTitle')
+    insertPart:         require('./insertPart'),
+    removePart:         require('./removePart'),
+    editPartTitle:      require('./editPartTitle')
 };

lib/modifiers/summary/insertArticle.js

@@ -1,63 +1,49 @@
 var is = require('is');
 var SummaryArticle = require('../../models/summaryArticle');
-var editArticle = require('./editArticle');
+var mergeAtLevel = require('./mergeAtLevel');
 var indexArticleLevels = require('./indexArticleLevels');
 
-
 /**
-    Get level of parent of an article
-
-    @param {String} level
-    @return {String}
-*/
-function getParentLevel(level) {
-    var parts = level.split('.');
-    return parts.slice(0, -1).join('.');
-}
-
-/**
-    Insert an article in a summary at a specific position
+    Returns a new Summary with the article at the given level, with
+    subsequent article shifted.
 
     @param {Summary} summary
-    @param {String|Article} level: level to insert after
     @param {Article} article
+    @param {String|Article} level: level to insert at
     @return {Summary}
 */
-function insertArticle(summary, level, article) {
+function insertArticle(summary, article, level) {
     article = SummaryArticle(article);
     level = is.string(level)? level : level.getLevel();
 
-    var parentLevel = getParentLevel(level);
-
-    if (!parentLevel) {
-        // todo: insert new part
-        return summary;
-    }
-
-    // Get parent of the position
-    var parentArticle = summary.getByLevel(parentLevel);
-    if (!parentLevel) {
+    var parent = summary.getParent(level);
+    if (!parent) {
         return summary;
     }
 
     // Find the index to insert at
-    var articles = parentArticle.getArticles();
-    var index = articles.findIndex(function(art) {
-        return art.getLevel() === level;
-    });
-    if (!index) {
-        return summary;
-    }
+    var articles = parent.getArticles();
+    var index = getLeafIndex(level);
 
     // Insert the article at the right index
     articles = articles.insert(index, article);
 
     // Reindex the level from here
-    parentArticle = parentArticle.set('articles', articles);
-    parentArticle = indexArticleLevels(parentArticle);
+    parent = parent.set('articles', articles);
+    parent = indexArticleLevels(parent);
 
-    return editArticle(summary, parentLevel, parentArticle);
+    return mergeAtLevel(summary, parent.getLevel(), parent);
+}
 
+/**
+    @param {String}
+    @return {Number} The index of this level within its parent's children
+ */
+function getLeafIndex(level) {
+    var arr = level.split('.').map(function (char) {
+        return parseInt(char, 10);
+    });
+    return arr[arr.length - 1] - 1;
 }
 
 module.exports = insertArticle;

lib/modifiers/summary/insertPart.js

@@ -0,0 +1,19 @@
+var SummaryPart = require('../../models/summaryPart');
+var indexLevels = require('./indexLevels');
+
+/**
+    Returns a new Summary with a part inserted at given index
+
+    @param {Summary} summary
+    @param {Part} part
+    @param {Number} index
+    @return {Summary}
+*/
+function insertPart(summary, part, index) {
+    part = SummaryPart(part);
+
+    var parts = summary.getParts().insert(index, part);
+    return indexLevels(summary.set('parts', parts));
+}
+
+module.exports = insertPart;

lib/modifiers/summary/mergeAtLevel.js

@@ -11,16 +11,17 @@ function editArticleInList(articles, level, newArticle) {
     return articles.map(function(article) {
         var articleLevel = article.getLevel();
 
-        if (articleLevel == level) {
+        if (articleLevel === level) {
+            // it is the article to edit
             return article.merge(newArticle);
-        }
-
-        if (level.indexOf(articleLevel) === 0) {
+        } else if (level.indexOf(articleLevel) === 0) {
+            // it is a parent
             var articles = editArticleInList(article.getArticles(), level, newArticle);
             return article.set('articles', articles);
+        } else {
+            // This is not the article you are looking for
+            return article;
         }
-
-        return article;
     });
 }
 
@@ -35,36 +36,40 @@ function editArticleInList(articles, level, newArticle) {
 */
 function editArticleInPart(part, level, newArticle) {
     var articles = part.getArticles();
-    articles = editArticleInList(articles);
+    articles = editArticleInList(articles, level, newArticle);
 
     return part.set('articles', articles);
 }
 
 
 /**
-    Edit an article in a summary
+    Edit an article, or a part, in a summary. Does a shallow merge.
 
     @param {Summary} summary
     @param {String} level
-    @param {Article} newArticle
+    @param {Article|Part} newValue
     @return {Summary}
 */
-function editArticle(summary, level, newArticle) {
-    var parts = summary.getParts();
-
+function mergeAtLevel(summary, level, newValue) {
     var levelParts = level.split('.');
-    var partIndex = Number(levelParts[0]);
+    var partIndex = Number(levelParts[0]) -1;
 
+    var parts = summary.getParts();
     var part = parts.get(partIndex);
     if (!part) {
         return summary;
     }
 
-    part = editArticleInPart(part, level, newArticle);
-    parts = parts.set(partIndex, part);
+    var isEditingPart = levelParts.length < 2;
+    if (isEditingPart) {
+        part = part.merge(newValue);
+    } else {
+        part = editArticleInPart(part, level, newValue);
+    }
 
+    parts = parts.set(partIndex, part);
     return summary.set('parts', parts);
 }
 
 
-module.exports = editArticle;
+module.exports = mergeAtLevel;

lib/modifiers/summary/moveArticle.js

@@ -0,0 +1,25 @@
+var is = require('is');
+var removeArticle = require('./removeArticle');
+var insertArticle = require('./insertArticle');
+
+/**
+    Returns a new summary, with the given article removed from its
+    origin level, and placed at the given target level.
+
+    @param {Summary} summary
+    @param {String|SummaryArticle} origin: level to remove
+    @param {String|SummaryArticle} target: the level where the article will be found
+    @return {Summary}
+*/
+function moveArticle(summary, origin, target) {
+    // Coerce to level
+    var originLevel = is.string(origin)? origin : origin.getLevel();
+    var targetLevel = is.string(target)? target : target.getLevel();
+    var article = summary.getByLevel(originLevel);
+
+    // Remove first
+    var removed = removeArticle(summary, originLevel);
+    return insertArticle(removed, article, targetLevel);
+}
+
+module.exports = moveArticle;

lib/modifiers/summary/moveArticleAfter.js

@@ -0,0 +1,60 @@
+var is = require('is');
+var removeArticle = require('./removeArticle');
+var insertArticle = require('./insertArticle');
+
+/**
+    Returns a new summary, with the an article moved after another
+    article. Unlike `moveArticle`, does not ensure that the article
+    will be found at the target's level plus one.
+
+    @param {Summary} summary
+    @param {String|SummaryArticle} origin
+    @param {String|SummaryArticle} afterTarget
+    @return {Summary}
+*/
+function moveArticleAfter(summary, origin, afterTarget) {
+    // Coerce to level
+    var originLevel = is.string(origin)? origin : origin.getLevel();
+    var afterTargetLevel = is.string(afterTarget)? afterTarget : afterTarget.getLevel();
+    var article = summary.getByLevel(originLevel);
+
+    var targetLevel = increment(afterTargetLevel);
+
+    if (targetLevel < origin) {
+        // Remove first
+        var removed = removeArticle(summary, originLevel);
+        // Insert then
+        return insertArticle(removed, article, targetLevel);
+    } else {
+        // Insert right after first
+        var inserted = insertArticle(summary, article, targetLevel);
+        // Remove old one
+        return removeArticle(inserted, originLevel);
+    }
+}
+
+/**
+    @param {String}
+    @return {Array<Number>}
+ */
+function levelToArray(l) {
+    return l.split('.').map(function (char) {
+        return parseInt(char, 10);
+    });
+}
+
+/**
+    @param {Array<Number>}
+    @return {String}
+ */
+function arrayToLevel(a) {
+    return a.join('.');
+}
+
+function increment(level) {
+    level = levelToArray(level);
+    level[level.length - 1]++;
+    return arrayToLevel(level);
+}
+
+module.exports = moveArticleAfter;

lib/modifiers/summary/removeArticle.js

@@ -0,0 +1,37 @@
+var is = require('is');
+var mergeAtLevel = require('./mergeAtLevel');
+var indexArticleLevels = require('./indexArticleLevels');
+
+/**
+    Remove an article from a level.
+
+    @param {Summary} summary
+    @param {String|SummaryArticle} level: level to remove
+    @return {Summary}
+*/
+function removeArticle(summary, level) {
+    // Coerce to level
+    level = is.string(level)? level : level.getLevel();
+
+    var parent = summary.getParent(level);
+
+    var articles = parent.getArticles();
+    // Find the index to remove
+    var index = articles.findIndex(function(art) {
+        return art.getLevel() === level;
+    });
+    if (index === -1) {
+        return summary;
+    }
+
+    // Remove from children
+    articles = articles.remove(index);
+    parent = parent.set('articles', articles);
+
+    // Reindex the level from here
+    parent = indexArticleLevels(parent);
+
+    return mergeAtLevel(summary, parent.getLevel(), parent);
+}
+
+module.exports = removeArticle;

lib/modifiers/summary/removePart.js

@@ -0,0 +1,15 @@
+var indexLevels = require('./indexLevels');
+
+/**
+    Remove a part at given index
+
+    @param {Summary} summary
+    @param {Number|} index
+    @return {Summary}
+*/
+function removePart(summary, index) {
+    var parts = summary.getParts().remove(index);
+    return indexLevels(summary.set('parts', parts));
+}
+
+module.exports = removePart;

lib/modifiers/summary/unshiftArticle.js

@@ -4,7 +4,7 @@ var SummaryPart = require('../../models/summaryPart');
 var indexLevels = require('./indexLevels');
 
 /**
-    Insert an article at the
+    Insert an article at the beginning of summary
 
     @param {Summary} summary
     @param {Article} article

lib/output/__tests__/ebook.js

@@ -3,7 +3,7 @@ var EbookGenerator = require('../ebook');
 
 describe('EbookGenerator', function() {
 
-    pit('should generate a SUMMARY.html', function() {
+    it('should generate a SUMMARY.html', function() {
         return generateMock(EbookGenerator, {
             'README.md': 'Hello World'
         })

lib/output/__tests__/json.js

@@ -3,7 +3,7 @@ var JSONGenerator = require('../json');
 
 describe('JSONGenerator', function() {
 
-    pit('should generate a README.json', function() {
+    it('should generate a README.json', function() {
         return generateMock(JSONGenerator, {
             'README.md': 'Hello World'
         })
@@ -12,7 +12,7 @@ describe('JSONGenerator', function() {
         });
     });
 
-    pit('should generate a json file for each articles', function() {
+    it('should generate a json file for each articles', function() {
         return generateMock(JSONGenerator, {
             'README.md': 'Hello World',
             'SUMMARY.md': '# Summary\n\n* [Page](test/page.md)',
@@ -25,5 +25,22 @@ describe('JSONGenerator', function() {
             expect(folder).toHaveFile('test/page.json');
         });
     });
+
+    it('should generate a multilingual book', function() {
+        return generateMock(JSONGenerator, {
+            'LANGS.md': '# Languages\n\n* [en](en)\n* [fr](fr)',
+            'en': {
+                'README.md': 'Hello'
+            },
+            'fr': {
+                'README.md': 'Bonjour'
+            }
+        })
+        .then(function(folder) {
+            expect(folder).toHaveFile('en/README.json');
+            expect(folder).toHaveFile('fr/README.json');
+            expect(folder).toHaveFile('README.json');
+        });
+    });
 });
 

lib/output/__tests__/website.js

@@ -1,9 +1,10 @@
+var fs = require('fs');
 var generateMock = require('../generateMock');
 var WebsiteGenerator = require('../website');
 
 describe('WebsiteGenerator', function() {
 
-    pit('should generate an index.html', function() {
+    it('should generate an index.html', function() {
         return generateMock(WebsiteGenerator, {
             'README.md': 'Hello World'
         })
@@ -12,7 +13,79 @@ describe('WebsiteGenerator', function() {
         });
     });
 
-    pit('should generate an HTML file for each articles', function() {
+    describe('Glossary', function() {
+        var folder;
+
+        before(function() {
+            return generateMock(WebsiteGenerator, {
+                'README.md': 'Hello World',
+                'SUMMARY.md': '* [Deep](folder/page.md)',
+                'folder': {
+                    'page.md': 'Hello World'
+                },
+                'GLOSSARY.md': '# Glossary\n\n## Hello\n\nHello World'
+            })
+            .then(function(_folder) {
+                folder = _folder;
+            });
+        });
+
+        it('should generate a GLOSSARY.html', function() {
+            expect(folder).toHaveFile('GLOSSARY.html');
+        });
+
+        it('should correctly resolve glossary links in README', function() {
+            var html = fs.readFileSync(folder + '/index.html', 'utf8');
+            expect(html).toHaveDOMElement('.page-inner a[href="GLOSSARY.html#hello"]');
+        });
+
+        it('should correctly resolve glossary links in directory', function() {
+            var html = fs.readFileSync(folder + '/folder/page.html', 'utf8');
+            expect(html).toHaveDOMElement('.page-inner a[href="../GLOSSARY.html#hello"]');
+        });
+
+        it('should accept a custom glossary file', function() {
+            return generateMock(WebsiteGenerator, {
+                'README.md': 'Hello World',
+                'book.json': '{ "structure": { "glossary": "custom.md" } }',
+                'custom.md': '# Glossary\n\n## Hello\n\nHello World'
+            })
+            .then(function(folder) {
+                expect(folder).toHaveFile('custom.html');
+                expect(folder).toNotHaveFile('GLOSSARY.html');
+
+                var html = fs.readFileSync(folder + '/index.html', 'utf8');
+                expect(html).toHaveDOMElement('.page-inner a[href="custom.html#hello"]');
+            });
+        });
+    });
+
+
+    it('should copy asset files', function() {
+        return generateMock(WebsiteGenerator, {
+            'README.md': 'Hello World',
+            'myJsFile.js': 'var a = "test";',
+            'folder': {
+                'AnotherAssetFile.md': '# Even md'
+            }
+        })
+        .then(function(folder) {
+            expect(folder).toHaveFile('index.html');
+            expect(folder).toHaveFile('myJsFile.js');
+            expect(folder).toHaveFile('folder/AnotherAssetFile.md');
+        });
+    });
+
+    it('should generate an index.html for AsciiDoc', function() {
+        return generateMock(WebsiteGenerator, {
+            'README.adoc': 'Hello World'
+        })
+        .then(function(folder) {
+            expect(folder).toHaveFile('index.html');
+        });
+    });
+
+    it('should generate an HTML file for each articles', function() {
         return generateMock(WebsiteGenerator, {
             'README.md': 'Hello World',
             'SUMMARY.md': '# Summary\n\n* [Page](test/page.md)',
@@ -26,7 +99,7 @@ describe('WebsiteGenerator', function() {
         });
     });
 
-    pit('should not generate file if entry file doesn\'t exist', function() {
+    it('should not generate file if entry file doesn\'t exist', function() {
         return generateMock(WebsiteGenerator, {
             'README.md': 'Hello World',
             'SUMMARY.md': '# Summary\n\n* [Page 1](page.md)\n* [Page 2](test/page.md)',
@@ -36,12 +109,12 @@ describe('WebsiteGenerator', function() {
         })
         .then(function(folder) {
             expect(folder).toHaveFile('index.html');
-            expect(folder).not.toHaveFile('page.html');
+            expect(folder).toNotHaveFile('page.html');
             expect(folder).toHaveFile('test/page.html');
         });
     });
 
-    pit('should generate a multilingual book', function() {
+    it('should generate a multilingual book', function() {
         return generateMock(WebsiteGenerator, {
             'LANGS.md': '# Languages\n\n* [en](en)\n* [fr](fr)',
             'en': {
@@ -57,12 +130,12 @@ describe('WebsiteGenerator', function() {
             expect(folder).toHaveFile('fr/index.html');
 
             // Should not copy languages as assets
-            expect(folder).not.toHaveFile('en/README.md');
-            expect(folder).not.toHaveFile('fr/README.md');
+            expect(folder).toNotHaveFile('en/README.md');
+            expect(folder).toNotHaveFile('fr/README.md');
 
             // Should copy assets only once
             expect(folder).toHaveFile('gitbook/style.css');
-            expect(folder).not.toHaveFile('en/gitbook/style.css');
+            expect(folder).toNotHaveFile('en/gitbook/style.css');
 
             expect(folder).toHaveFile('index.html');
         });

lib/output/createTemplateEngine.js

@@ -28,7 +28,8 @@ function createTemplateEngine(output) {
     filters = defaultFilters.merge(filters);
 
     // Create loader
-    var loader = new Templating.ConrefsLoader(rootFolder, logger);
+    var transformFn = Templating.replaceShortcuts.bind(null, blocks);
+    var loader = new Templating.ConrefsLoader(rootFolder, transformFn, logger);
 
     // Create API context
     var context = Api.encodeGlobal(output);

lib/output/ebook/getCoverPath.js

@@ -11,17 +11,17 @@ function getCoverPath(output) {
     var outputRoot = output.getRoot();
     var book = output.getBook();
     var config = book.getConfig();
-    var cover = config.getValue('cover', 'cover.jpg');
+    var coverName = config.getValue('cover', 'cover.jpg');
 
     // Resolve to absolute
-    cover = fs.pickFile(outputRoot, cover);
+    var cover = fs.pickFile(outputRoot, coverName);
     if (cover) {
         return cover;
     }
 
     // Multilingual? try parent folder
     if (book.isLanguageBook()) {
-        cover = fs.pickFile(path.join(outputRoot, '..'), cover);
+        cover = fs.pickFile(path.join(outputRoot, '..'), coverName);
     }
 
     return cover;

lib/output/ebook/getPDFTemplate.js

@@ -22,16 +22,15 @@ function getPDFTemplate(output, type) {
     var context = JSONUtils.encodeOutput(output);
     context.page = {
         num: '_PAGENUM_',
-        title: '_TITLE_',
-        section: '_SECTION_'
+        title: '_SECTION_'
     };
 
     // Render the theme
     return Templating.renderFile(engine, 'ebook/' + filePath, context)
 
     // Inline css and assets
-    .then(function(html) {
-        return Promise.nfcall(juice.juiceResources, html, {
+    .then(function(tplOut) {
+        return Promise.nfcall(juice.juiceResources, tplOut.getContent(), {
             webResources: {
                 relativeTo: outputRoot
             }

lib/output/ebook/onFinish.js

@@ -9,6 +9,7 @@ var command = require('../../utils/command');
 var writeFile = require('../helper/writeFile');
 
 var getConvertOptions = require('./getConvertOptions');
+var SUMMARY_FILE = 'SUMMARY.html';
 
 /**
     Write the SUMMARY.html
@@ -20,16 +21,16 @@ function writeSummary(output) {
     var options = output.getOptions();
     var prefix = options.get('prefix');
 
-    var filePath = 'SUMMARY.html';
+    var filePath = SUMMARY_FILE;
     var engine = WebsiteGenerator.createTemplateEngine(output, filePath);
     var context = JSONUtils.encodeOutput(output);
 
     // Render the theme
-    return Templating.renderFile(engine, prefix + '/SUMMARY.html', context)
+    return Templating.renderFile(engine, prefix + '/summary.html', context)
 
     // Write it to the disk
-    .then(function(html) {
-        return writeFile(output, filePath, html);
+    .then(function(tplOut) {
+        return writeFile(output, filePath, tplOut.getContent());
     });
 }
 
@@ -53,7 +54,7 @@ function runEbookConvert(output) {
     .then(function(options) {
         var cmd = [
             'ebook-convert',
-            path.resolve(outputFolder, 'SUMMARY.html'),
+            path.resolve(outputFolder, SUMMARY_FILE),
             path.resolve(outputFolder, 'index.' + format),
             command.optionsToShellArgs(options)
         ].join(' ');

lib/output/ebook/onPage.js

@@ -12,7 +12,7 @@ function onPage(output, page) {
 
     // Inline assets
     return Modifiers.modifyHTML(page, [
-        Modifiers.inlineAssets(options.get('root'))
+        Modifiers.inlineAssets(options.get('root'), page.getFile().getPath())
     ])
 
     // Write page using website generator

lib/output/generateBook.js

@@ -2,7 +2,6 @@ var path = require('path');
 var Immutable = require('immutable');
 
 var Output = require('../models/output');
-var Config = require('../models/config');
 var Promise = require('../utils/promise');
 var fs = require('../utils/fs');
 
@@ -41,7 +40,7 @@ function processOutput(generator, startOutput) {
                 var book = output.getBook();
                 var config = book.getConfig();
 
-                config = Config.updateValues(config, result);
+                config = config.updateValues(result);
                 book = book.set('config', config);
                 return output.set('book', book);
             }
@@ -78,6 +77,7 @@ function processOutput(generator, startOutput) {
             return;
         }
 
+        var logger = book.getLogger();
         var books = book.getBooks();
         var outputRoot = output.getRoot();
         var plugins = output.getPlugins();
@@ -95,6 +95,8 @@ function processOutput(generator, startOutput) {
                 plugins:    plugins
             });
 
+            logger.info.ln('');
+            logger.info.ln('generating language "' + langBook.getLanguage() + '"');
             return processOutput(generator, langOutput);
         });
     })

lib/output/generateMock.js

@@ -19,7 +19,13 @@ var generateBook = require('./generateBook');
 function generateMock(Generator, files) {
     var fs = createMockFS(files);
     var book = Book.createForFS(fs);
-    var dir = tmp.dirSync();
+    var dir;
+
+    try {
+        dir = tmp.dirSync();
+    } catch(err) {
+        throw err;
+    }
 
     book = book.setLogLevel('disabled');
 

lib/output/generatePage.js

@@ -1,8 +1,9 @@
+var path = require('path');
+
 var Promise = require('../utils/promise');
 var error = require('../utils/error');
 var timing = require('../utils/timing');
 
-var Parse = require('../parse');
 var Templating = require('../templating');
 var JSONUtils = require('../json');
 var createTemplateEngine = require('./createTemplateEngine');
@@ -21,7 +22,7 @@ function generatePage(output, page) {
 
     return timing.measure(
         'page.generate',
-        Parse.parsePage(book, page)
+        Promise(page)
         .then(function(resultPage) {
             var file = resultPage.getFile();
             var filePath = file.getPath();
@@ -44,15 +45,22 @@ function generatePage(output, page) {
 
             // Render templating syntax
             .then(function(content) {
-                return Templating.render(engine, filePath, content, context);
+                var absoluteFilePath = path.join(book.getContentRoot(), filePath);
+                return Templating.render(engine, absoluteFilePath, content, context);
             })
 
-            // Render page using parser (markdown -> HTML)
-            .then(parser.parsePage.bind(parser)).get('content')
+            .then(function(output) {
+                var content = output.getContent();
+
+                return parser.parsePage(content)
+                .then(function(result) {
+                    return output.setContent(result.content);
+                });
+            })
 
             // Post processing for templating syntax
-            .then(function(content) {
-                return Templating.postRender(engine, content);
+            .then(function(output) {
+                return Templating.postRender(engine, output);
             })
 
             // Return new page

lib/output/getModifiers.js

@@ -4,6 +4,7 @@ var Api = require('../api');
 var Plugins = require('../plugins');
 var Promise = require('../utils/promise');
 var defaultBlocks = require('../constants/defaultBlocks');
+var fileToOutput = require('./helper/fileToOutput');
 
 var CODEBLOCK = 'code';
 
@@ -17,9 +18,13 @@ function getModifiers(output, page) {
     var book = output.getBook();
     var plugins = output.getPlugins();
     var glossary = book.getGlossary();
-    var entries = glossary.getEntries();
     var file = page.getFile();
 
+    // Glossary entries
+    var entries = glossary.getEntries();
+    var glossaryFile = glossary.getFile();
+    var glossaryFilename = fileToOutput(output, glossaryFile.getPath());
+
     // Current file path
     var currentFilePath = file.getPath();
 
@@ -34,18 +39,18 @@ function getModifiers(output, page) {
         // Normalize IDs on headings
         Modifiers.addHeadingId,
 
+        // Annotate text with glossary entries
+        Modifiers.annotateText.bind(null, entries, glossaryFilename),
+
+        // Resolve images
+        Modifiers.resolveImages.bind(null, currentFilePath),
+
         // Resolve links (.md -> .html)
         Modifiers.resolveLinks.bind(null,
             currentFilePath,
             resolveFileToURL.bind(null, output)
         ),
 
-        // Resolve images
-        Modifiers.resolveImages.bind(null, currentFilePath),
-
-        // Annotate text with glossary entries
-        Modifiers.annotateText.bind(null, entries),
-
         // Highlight code blocks using "code" block
         Modifiers.highlightCode.bind(null, function(lang, source) {
             return Promise(code.applyBlock({

lib/output/helper/resolveFileToURL.js

@@ -13,8 +13,7 @@ function resolveFileToURL(output, filePath) {
     // Convert /test.png -> test.png
     filePath = LocationUtils.toAbsolute(filePath, '', '');
 
-    var pages = output.getPages();
-    var page = pages.get(filePath);
+    var page = output.getPage(filePath);
 
     // if file is a page, return correct .html url
     if (page) {

lib/output/json/index.js

@@ -2,5 +2,6 @@
 module.exports = {
     name:       'json',
     Options:    require('./options'),
-    onPage:     require('./onPage')
+    onPage:     require('./onPage'),
+    onFinish:   require('./onFinish')
 };

lib/output/json/onFinish.js

@@ -2,6 +2,7 @@ var path = require('path');
 
 var Promise = require('../../utils/promise');
 var fs = require('../../utils/fs');
+var JSONUtils = require('../../json');
 
 /**
     Finish the generation
@@ -21,11 +22,25 @@ function onFinish(output) {
     var languages = book.getLanguages();
     var mainLanguage = languages.getDefaultLanguage();
 
-    // Copy README.json from it
-    return fs.copy(
-        path.resolve(outputRoot, mainLanguage.getID(), 'README.json'),
-        path.resolve(outputRoot, 'README.json')
-    )
+    // Read the main JSON
+    return fs.readFile(path.resolve(outputRoot, mainLanguage.getID(), 'README.json'), 'utf8')
+
+    // Extend the JSON
+    .then(function(content) {
+        var json = JSON.parse(content);
+
+        json.languages = JSONUtils.encodeLanguages(languages);
+
+        return json;
+    })
+
+    .then(function(json) {
+        return fs.writeFile(
+            path.resolve(outputRoot, 'README.json'),
+            JSON.stringify(json, null, 4)
+        );
+    })
+
     .thenResolve(output);
 }
 

lib/output/modifiers/__tests__/addHeadingId.js

@@ -1,11 +1,8 @@
-jest.autoMockOff();
-
 var cheerio = require('cheerio');
+var addHeadingId = require('../addHeadingId');
 
 describe('addHeadingId', function() {
-    var addHeadingId = require('../addHeadingId');
-
-    pit('should add an ID if none', function() {
+    it('should add an ID if none', function() {
         var $ = cheerio.load('<h1>Hello World</h1><h2>Cool !!</h2>');
 
         return addHeadingId($)
@@ -15,7 +12,7 @@ describe('addHeadingId', function() {
         });
     });
 
-    pit('should not change existing IDs', function() {
+    it('should not change existing IDs', function() {
         var $ = cheerio.load('<h1 id="awesome">Hello World</h1>');
 
         return addHeadingId($)

lib/output/modifiers/__tests__/annotateText.js

@@ -1,12 +1,9 @@
-jest.autoMockOff();
-
 var Immutable = require('immutable');
 var cheerio = require('cheerio');
 var GlossaryEntry = require('../../../models/glossaryEntry');
+var annotateText = require('../annotateText');
 
 describe('annotateText', function() {
-    var annotateText = require('../annotateText');
-
     var entries = Immutable.List([
         GlossaryEntry({ name: 'Word' }),
         GlossaryEntry({ name: 'Multiple Words' })
@@ -15,7 +12,7 @@ describe('annotateText', function() {
     it('should annotate text', function() {
         var $ = cheerio.load('<p>This is a word, and multiple words</p>');
 
-        annotateText(entries, $);
+        annotateText(entries, 'GLOSSARY.md', $);
 
         var links = $('a');
         expect(links.length).toBe(2);
@@ -34,14 +31,14 @@ describe('annotateText', function() {
     it('should not annotate scripts', function() {
         var $ = cheerio.load('<script>This is a word, and multiple words</script>');
 
-        annotateText(entries, $);
+        annotateText(entries, 'GLOSSARY.md', $);
         expect($('a').length).toBe(0);
     });
 
     it('should not annotate when has class "no-glossary"', function() {
         var $ = cheerio.load('<p class="no-glossary">This is a word, and multiple words</p>');
 
-        annotateText(entries, $);
+        annotateText(entries, 'GLOSSARY.md', $);
         expect($('a').length).toBe(0);
     });
 });

lib/output/modifiers/__tests__/fetchRemoteImages.js

@@ -12,7 +12,7 @@ describe('fetchRemoteImages', function() {
         dir = tmp.dirSync();
     });
 
-    pit('should download image file', function() {
+    it('should download image file', function() {
         var $ = cheerio.load('<img src="' + URL + '" />');
 
         return fetchRemoteImages(dir.name, 'index.html', $)
@@ -24,7 +24,7 @@ describe('fetchRemoteImages', function() {
         });
     });
 
-    pit('should download image file and replace with relative path', function() {
+    it('should download image file and replace with relative path', function() {
         var $ = cheerio.load('<img src="' + URL + '" />');
 
         return fetchRemoteImages(dir.name, 'test/index.html', $)

lib/output/modifiers/__tests__/highlightCode.js

@@ -1,11 +1,8 @@
-jest.autoMockOff();
-
 var cheerio = require('cheerio');
 var Promise = require('../../../utils/promise');
+var highlightCode = require('../highlightCode');
 
 describe('highlightCode', function() {
-    var highlightCode = require('../highlightCode');
-
     function doHighlight(lang, code) {
         return {
             text: '' + (lang || '') + '$' + code
@@ -19,7 +16,7 @@ describe('highlightCode', function() {
         });
     }
 
-    pit('should call it for normal code element', function() {
+    it('should call it for normal code element', function() {
         var $ = cheerio.load('<p>This is a <code>test</code></p>');
 
         return highlightCode(doHighlight, $)
@@ -29,7 +26,7 @@ describe('highlightCode', function() {
         });
     });
 
-    pit('should call it for markdown code block', function() {
+    it('should call it for markdown code block', function() {
         var $ = cheerio.load('<pre><code class="lang-js">test</code></pre>');
 
         return highlightCode(doHighlight, $)
@@ -39,7 +36,7 @@ describe('highlightCode', function() {
         });
     });
 
-    pit('should call it for asciidoc code block', function() {
+    it('should call it for asciidoc code block', function() {
         var $ = cheerio.load('<pre><code class="language-python">test</code></pre>');
 
         return highlightCode(doHighlight, $)
@@ -49,7 +46,7 @@ describe('highlightCode', function() {
         });
     });
 
-    pit('should accept async highlighter', function() {
+    it('should accept async highlighter', function() {
         var $ = cheerio.load('<pre><code class="language-python">test</code></pre>');
 
         return highlightCode(doHighlightAsync, $)

lib/output/modifiers/__tests__/inlinePng.js

@@ -0,0 +1,25 @@
+var cheerio = require('cheerio');
+var tmp = require('tmp');
+var inlinePng = require('../inlinePng');
+
+describe('inlinePng', function() {
+    var dir;
+
+    beforeEach(function() {
+        dir = tmp.dirSync();
+    });
+
+    it('should write an inline PNG using data URI as a file', function() {
+        var $ = cheerio.load('<img alt="GitBook Logo 20x20" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUEAYAAADdGcFOAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAACXBIWXMAAAsTAAALEwEAmpwYAAABWWlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNS40LjAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgpMwidZAAAF+klEQVRIDY3Wf5CVVR3H8c9z791fyI9dQwdQ4TTI7wEWnQZZAa/mJE4Z0OaKUuN1KoaykZxUGGHay+iIVFMoEYrUPhDCKEKW2ChT8dA0RCSxWi6EW3sYYpcfxq5C+4O9957O+7m7O/qHQ9/XzH1+nHuec57z8wkWTsKw0y6N/LxXN6KzTnEUHi8eP/l3YStSU/MdsYvBbGh8six2YXcbcgc++QkfTQkWz/81KtqDA0hlUoWnsX+5uxe5X365BB9my2bjrHNHccLk16BpS9CExjcmXMDbD6wehdyEjxbjz1uK1zn9qga6dcfnMLXeXY/qjuQqTF4W1MKke8ZgeNhjMCxMPIWSd4OF78C55CFI/1kF6WwXpMqjkAZ/CKniNDrCsmU4lE1YbPlgR2x7R39FF23D4mq3A1+Z35PGTNs1E1XhxcGQOh6HNPwXkK56BVJhOaRg/pvoHXNxHFw410B25EYE2RMvI0i/twFJvXcrFObykEa+DmnQGLwYqR0l2a6JqItaj8C/4E2QxtZCofkC8tF1t8HZc/fAZaLnIF2xEsoEtW1w7vBSSFtfhDTnCki9cSi81Ain1uko2Ld+Dmf2rkUq0/5t+PYbFtPQdkjzNiAXTWtDEF49FgkzJInAVPwNyhzcDOmrdZCm/Rn+ebWtcPs+/U24hmg2XL0rRkPPELh9R8fDtXR2oC/VuZbGaci79Ajkb6lZgfyYtyzy/X9s6T/pO/ZfN/RdNxxIwTWM2wbX8KVmuIaEqmKm6zEondwGpd0SyOy5DrJ//TFkX9kMhd3XQHbEVCSsm4OECV5HIv2p15CwfWPSntoHRbv2Q1HzSvSlSqZwATIuBxk/zZBOBbdB+u9hSKU3Q7pwAjInZkFm6U8hu7MSMqe/Dqn8fUj5GVCmpxK+4N/F1LMa0p5eSOPqIPP7NGSunAI/+R6GnzQzIBt8A1LC/QZ+6HwLst1rITv0n5CtXgSZ78yFTNkR+FdeDZneJkip3fAtsQ5Scilkek7CH9dAmjIWvkK7IXXOh6/IzZDNPQdZXR1TQmdjKv0ZfEu0YKDpNflpyG5aDtnRv8VAuu3dBV+huyBbvgdS97tQNLQc0mfugKy5Cb4BipPIXvsUpK5N8Mvao/Bd3QDZRH9Rrtj3Cl6FHwPFMLmNkKrj8BnHoT+XX6f2wl+XxFS4Ab7C72Dgf7bi+5DpTkNm8kQMpCs/BzIlz8LfPxnzLdh3EjwMX4GX4Ju4GNb9A1L7k/D3J8b6kv2LFCtmCmcgUzoJsr2z4MfwFsh87xikZefg188fYaAhpPUxm3ge/vFnYkoED0HqeQiyJYcwkNGWnoNv6s9C1p1Bf/389VYoCjohW7UfMms3wXdpBv7+FEiPLIHs4DIMNERUNhbSpY3wk6QOsqlCDVx2xCrInMpBmfNPQOnzKxBkkrugdOl9GKigSZZCUWIm/GqwDtLUI5D+WAOlb9wKP0YvQLbjZSjsaYaL/n0/FA3fDtnCGihK5UYjCK+ZDr+TDIKLdm2Fs1UOzo76F5wO74XSZj0S6d7RCMLkCshcXALZxaWQRjXDZQ62oRAdCeG/Ju5HELX2QFH3C0hkRy6GovyfwF58AoVbguOxyB2H7/I34Gf11yANnQSp7Vr4MbQH0vg7kbNNp5AM3UrIVDchnz56B1Jm573wW9gZSFVPwO/hefg5FsIvN09CchtQCIOFw/F5U8ii3CZn4cqo7C8YlXEPYkx9cacZl00+iwnprrtwVdj1Q/gXmAs/pu6LZc9XQOGgSvh19n2cDZN341g2EcfxTEGwH/RewqlMsUfbbWIGLjUG+j/j9nokD1beiOvLS5dhjr30Gu6ZnivgdtM/6VJvY1+6pBHbH+h9CX84vfMxNJtisYVFlys+WNCIZJNmIsjohlhNSQC3f8R55H+y/hjkN8GPR9ndCLJxT4/3n0Px51ay8XQnNrYfDJHf//Fc0oMrEZSeeQGJ7+Z+gKCgLbHNWgXnB9FlYt5JaN38JIINC95EakjtAqQeuUx21c5B6tEFf0fSfbEFQf28Z6D6y+X/H0jf40QQJhYwAAAAAElFTkSuQmCC"/>');
+
+        return inlinePng(dir.name, 'index.html', $)
+        .then(function() {
+            var $img = $('img');
+            var src = $img.attr('src');
+
+            expect(dir.name).toHaveFile(src);
+        });
+    });
+});
+
+

lib/output/modifiers/__tests__/resolveLinks.js

@@ -1,13 +1,10 @@
-jest.autoMockOff();
-
 var path = require('path');
 var cheerio = require('cheerio');
+var resolveLinks = require('../resolveLinks');
 
 describe('resolveLinks', function() {
-    var resolveLinks = require('../resolveLinks');
-
     function resolveFileBasic(href) {
-        return href;
+        return 'fakeDir/' + href;
     }
 
     function resolveFileCustom(href) {
@@ -21,23 +18,47 @@ describe('resolveLinks', function() {
     describe('Absolute path', function() {
         var TEST = '<p>This is a <a href="/test/cool.md"></a></p>';
 
-        pit('should resolve path starting by "/" in root directory', function() {
+        it('should resolve path starting by "/" in root directory', function() {
             var $ = cheerio.load(TEST);
 
             return resolveLinks('hello.md', resolveFileBasic, $)
             .then(function() {
                 var link = $('a');
-                expect(link.attr('href')).toBe('test/cool.md');
+                expect(link.attr('href')).toBe('fakeDir/test/cool.md');
             });
         });
 
-        pit('should resolve path starting by "/" in child directory', function() {
+        it('should resolve path starting by "/" in child directory', function() {
             var $ = cheerio.load(TEST);
 
             return resolveLinks('afolder/hello.md', resolveFileBasic, $)
             .then(function() {
                 var link = $('a');
-                expect(link.attr('href')).toBe('../test/cool.md');
+                expect(link.attr('href')).toBe('../fakeDir/test/cool.md');
+            });
+        });
+    });
+
+    describe('Anchor', function() {
+        it('should prevent anchors in resolution', function() {
+            var TEST = '<p>This is a <a href="test/cool.md#an-anchor"></a></p>';
+            var $ = cheerio.load(TEST);
+
+            return resolveLinks('hello.md', resolveFileCustom, $)
+            .then(function() {
+                var link = $('a');
+                expect(link.attr('href')).toBe('test/cool.html#an-anchor');
+            });
+        });
+
+        it('should ignore pure anchor links', function() {
+            var TEST = '<p>This is a <a href="#an-anchor"></a></p>';
+            var $ = cheerio.load(TEST);
+
+            return resolveLinks('hello.md', resolveFileCustom, $)
+            .then(function() {
+                var link = $('a');
+                expect(link.attr('href')).toBe('#an-anchor');
             });
         });
     });
@@ -45,7 +66,7 @@ describe('resolveLinks', function() {
     describe('Custom Resolver', function() {
         var TEST = '<p>This is a <a href="/test/cool.md"></a> <a href="afile.png"></a></p>';
 
-        pit('should resolve path correctly for absolute path', function() {
+        it('should resolve path correctly for absolute path', function() {
             var $ = cheerio.load(TEST);
 
             return resolveLinks('hello.md', resolveFileCustom, $)
@@ -55,7 +76,7 @@ describe('resolveLinks', function() {
             });
         });
 
-        pit('should resolve path correctly for absolute path (2)', function() {
+        it('should resolve path correctly for absolute path (2)', function() {
             var $ = cheerio.load(TEST);
 
             return resolveLinks('afodler/hello.md', resolveFileCustom, $)

lib/output/modifiers/__tests__/svgToImg.js

@@ -9,7 +9,7 @@ describe('svgToImg', function() {
         dir = tmp.dirSync();
     });
 
-    pit('should write svg as a file', function() {
+    it('should write svg as a file', function() {
         var $ = cheerio.load('<svg xmlns="http://www.w3.org/2000/svg" width="200" height="100" version="1.1"><rect width="200" height="100" stroke="black" stroke-width="6" fill="green"/></svg>');
 
         return svgToImg(dir.name, 'index.html', $)

lib/output/modifiers/__tests__/svgToPng.js

@@ -2,16 +2,17 @@ var cheerio = require('cheerio');
 var tmp = require('tmp');
 var path = require('path');
 
+var svgToImg = require('../svgToImg');
+var svgToPng = require('../svgToPng');
+
 describe('svgToPng', function() {
     var dir;
-    var svgToImg = require('../svgToImg');
-    var svgToPng = require('../svgToPng');
 
     beforeEach(function() {
         dir = tmp.dirSync();
     });
 
-    pit('should write svg as png file', function() {
+    it('should write svg as png file', function() {
         var $ = cheerio.load('<svg xmlns="http://www.w3.org/2000/svg" width="200" height="100" version="1.1"><rect width="200" height="100" stroke="black" stroke-width="6" fill="green"/></svg>');
         var fileName = 'index.html';
 

lib/output/modifiers/annotateText.js

@@ -62,9 +62,10 @@ function replaceText($, el, search, replace, text_only ) {
     Annotate text using a list of GlossaryEntry
 
     @param {List<GlossaryEntry>}
+    @param {String} glossaryFilePath
     @param {HTMLDom} $
 */
-function annotateText(entries, $) {
+function annotateText(entries, glossaryFilePath, $) {
     entries.forEach(function(entry) {
         var entryId = entry.getID();
         var name = entry.getName();
@@ -81,7 +82,7 @@ function annotateText(entries, $) {
             ) return;
 
             replaceText($, this, searchRegex, function(match) {
-                return '<a href="/GLOSSARY.md#' + entryId + '" '
+                return '<a href="/' + glossaryFilePath + '#' + entryId + '" '
                     + 'class="glossary-term" title="' + escape(description) + '">'
                     + match
                     + '</a>';

lib/output/modifiers/highlightCode.js

@@ -1,4 +1,6 @@
 var is = require('is');
+var Immutable = require('immutable');
+
 var Promise = require('../../utils/promise');
 var editHTMLElement = require('./editHTMLElement');
 
@@ -9,7 +11,7 @@ var editHTMLElement = require('./editHTMLElement');
     @return {String}
 */
 function getLanguageForClass(classNames) {
-    return classNames
+    return Immutable.List(classNames)
         .map(function(cl) {
             // Markdown
             if (cl.search('lang-') === 0) {