Bump version to 3.2.1

By adding the Loomio and Enspiral handbook examples

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,19 @@
+Thank you for giving us your feedback! We listed some guidelines to help you:
+
+If possible, open separate issues for each bug report. Avoid grouping bugs that are unrelated.
+
+### What is the current behavior?
+
+If the current behavior is a bug, please provide the steps to reproduce. if possible, provide the GitBook version being used (`gitbook -V`) and the system infromations (OS and version).
+
+### What is the expected behavior?
+
+How do you think, or how would you like it should behave.
+
+#### For GitBook.com
+
+Provide, if possible, your username and the URL of the concerned book.
+
+----
+
+The GitBook Team

.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: node_js
+os:
+  - linux
+  - osx
 node_js:
   - "stable"
   - "4.1"

CHANGES.md

@@ -2,9 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## 3.2.0 (pre)
+## 3.2.0
 - Switch markdown parser from `kramed` to `markup-it`
 - Fix support of `|` in tables
+- Fix access to `output.name` in templating
+- Fix i18n for website and PDF
+- Fix minor scrolling issues on website
+- Improve options of default search indexer (keywords, disabling per pages)
+- Improve pertinence of search results
 
 ## 3.1.1
 - Fix order of plugins during loading

book.js

@@ -6,10 +6,10 @@ module.exports = {
     title: 'GitBook Toolchain Documentation',
 
     // Enforce use of GitBook v3
-    gitbook: '>=3.0.0-pre.0',
+    gitbook: '3.1.1',
 
     // Use the "official" theme
-    plugins: ['theme-official', 'sitemap'],
+    plugins: ['theme-official@2.1.1', '-sharing', '-fontsettings', 'sitemap'],
 
     variables: {
         version: pkg.version

docs/examples.md

@@ -23,5 +23,7 @@ More than 50,000 books have been published on [GitBook.com](https://www.gitbook.
 ### Documentation
 
 - [DuckDuckHack Documentation](http://docs.duckduckhack.com) by [DuckDuckGo](https://duckduckgo.com/about)
+- [Loomio Handbook](http://loomio.coop/) by [Loomio](https://www.loomio.org/)
+- [Enspiral Handbook](http://handbook.enspiral.com/) by [Enspiral](http://enspiral.com/)
 - This documentation
 

docs/plugins/testing.md

@@ -2,7 +2,7 @@
 
 ### Testing your plugin locally
 
-Testing your plugin on your book before plushing it is possible using [npm link](https://docs.npmjs.com/cli/link).
+Testing your plugin on your book before publishing it is possible using [npm link](https://docs.npmjs.com/cli/link).
 
 In the plugin's folder, run:
 
@@ -10,7 +10,7 @@ In the plugin's folder, run:
 $ npm link
 ```
 
-The nin your book's folder:
+Then in your book's folder:
 
 ```
 $ npm link gitbook-plugin-<plugin's name>

docs/styles/website.css

@@ -0,0 +1,4 @@
+/* Reduce size of logo to allow long versions like 3.0.0-pre.1 */
+.gb-page-header .container .logo h1 {
+    font-size: 24px ;
+}

lib/browser.js

@@ -6,6 +6,7 @@ module.exports = {
     // Models
     Book:               require('./models/book'),
     FS:                 require('./models/fs'),
+    File:               require('./models/file'),
     Summary:            require('./models/summary'),
     Glossary:           require('./models/glossary'),
     Config:             require('./models/config'),

lib/constants/configSchema.js

@@ -18,6 +18,10 @@ module.exports = {
             'type': 'string',
             'title': 'ISBN for published book'
         },
+        'language': {
+            'type': 'string',
+            'title': 'Language of the book'
+        },
         'author': {
             'type': 'string',
             'title': 'Name of the author'

lib/json/encodeBookWithPage.js

@@ -3,12 +3,12 @@ var encodePage = require('./encodePage');
 var encodeFile = require('./encodeFile');
 
 /**
-    Return a JSON representation of a book with a specific file
-
-    @param {Book} output
-    @param {Page} page
-    @return {Object}
-*/
+ * Return a JSON representation of a book with a specific file
+ *
+ * @param {Book} output
+ * @param {Page} page
+ * @return {Object}
+ */
 function encodeBookWithPage(book, page) {
     var file = page.getFile();
 

lib/json/encodeOutput.js

@@ -1,11 +1,11 @@
 var encodeBook = require('./encodeBook');
 
 /**
-    Encode an output to JSON
-
-    @param {Output}
-    @return {Object}
-*/
+ * Encode an output to JSON
+ *
+ * @param {Output}
+ * @return {Object}
+ */
 function encodeOutputToJson(output) {
     var book = output.getBook();
     var generator = output.getGenerator();

lib/json/encodeOutputWithPage.js

@@ -0,0 +1,23 @@
+var encodeOutput = require('./encodeOutput');
+var encodePage = require('./encodePage');
+var encodeFile = require('./encodeFile');
+
+/**
+ * Return a JSON representation of a book with a specific file
+ *
+ * @param {Book} output
+ * @param {Page} page
+ * @return {Object}
+ */
+function encodeOutputWithPage(output, page) {
+    var file = page.getFile();
+    var book = output.getBook();
+
+    var result = encodeOutput(output);
+    result.page = encodePage(page, book.getSummary());
+    result.file = encodeFile(file);
+
+    return result;
+}
+
+module.exports = encodeOutputWithPage;

lib/json/index.js

@@ -2,6 +2,7 @@
 module.exports = {
     encodeOutput:           require('./encodeOutput'),
     encodeBookWithPage:     require('./encodeBookWithPage'),
+    encodeOutputWithPage:   require('./encodeOutputWithPage'),
     encodeBook:             require('./encodeBook'),
     encodeFile:             require('./encodeFile'),
     encodePage:             require('./encodePage'),

lib/modifiers/config/editPlugin.js

@@ -7,7 +7,7 @@
  * @return {Config}
  */
 function editPlugin(config, pluginName, pluginConfig) {
-    return config.set('pluginsConfig.'+pluginName, pluginConfig);
+    return config.setValue('pluginsConfig.'+pluginName, pluginConfig);
 }
 
 module.exports = editPlugin;

lib/modifiers/config/getPluginConfig.js

@@ -0,0 +1,20 @@
+/**
+ * Return the configuration for a plugin
+ * @param {Config} config
+ * @param {String} pluginName
+ * @return {Object}
+ */
+function getPluginConfig(config, pluginName) {
+    var pluginsConfig = config.getValues().get('pluginsConfig');
+    if (pluginsConfig === undefined) {
+        return {};
+    }
+    var pluginConf = pluginsConfig.get(pluginName);
+    if (pluginConf === undefined) {
+        return {};
+    } else {
+        return pluginConf.toJS();
+    }
+}
+
+module.exports = getPluginConfig;

lib/modifiers/config/index.js

@@ -5,5 +5,6 @@ module.exports = {
     togglePlugin:    require('./togglePlugin'),
     editPlugin:      require('./editPlugin'),
     hasPlugin:       require('./hasPlugin'),
+    getPluginConfig: require('./getPluginConfig'),
     isDefaultPlugin: require('./isDefaultPlugin')
 };

lib/output/__tests__/createMock.js

@@ -0,0 +1,38 @@
+var Immutable = require('immutable');
+
+var Output = require('../../models/output');
+var Book = require('../../models/book');
+var parseBook = require('../../parse/parseBook');
+var createMockFS = require('../../fs/mock');
+var preparePlugins = require('../preparePlugins');
+
+/**
+ * Create an output using a generator
+ *
+ * FOR TESTING PURPOSE ONLY
+ *
+ * @param {Generator} generator
+ * @param {Map<String:String|Map>} files
+ * @return {Promise<Output>}
+ */
+function createMockOutput(generator, files, options) {
+    var fs = createMockFS(files);
+    var book = Book.createForFS(fs);
+    var state = generator.State? generator.State({}) : Immutable.Map();
+
+    book = book.setLogLevel('disabled');
+    options = generator.Options(options);
+
+    return parseBook(book)
+    .then(function(resultBook) {
+        return new Output({
+            book:      resultBook,
+            options:   options,
+            state:     state,
+            generator: generator.name
+        });
+    })
+    .then(preparePlugins);
+}
+
+module.exports = createMockOutput;

lib/output/__tests__/ebook.js

@@ -1,4 +1,4 @@
-var generateMock = require('../generateMock');
+var generateMock = require('./generateMock');
 var EbookGenerator = require('../ebook');
 
 describe('EbookGenerator', function() {

lib/output/__tests__/generateMock.js

@@ -1,21 +1,20 @@
 var tmp = require('tmp');
 
-var Book = require('../models/book');
-var createMockFS = require('../fs/mock');
-var parseBook = require('../parse/parseBook');
-var generateBook = require('./generateBook');
-
+var Book = require('../../models/book');
+var createMockFS = require('../../fs/mock');
+var parseBook = require('../../parse/parseBook');
+var generateBook = require('../generateBook');
 
 /**
-    Generate a book using JSON generator
-    And returns the path to the output dir.
-
-    FOR TESTING PURPOSE ONLY
-
-    @param {Generator}
-    @param {Map<String:String|Map>} files
-    @return {Promise<String>}
-*/
+ * Generate a book using a generator
+ * And returns the path to the output dir.
+ *
+ * FOR TESTING PURPOSE ONLY
+ *
+ * @param {Generator}
+ * @param {Map<String:String|Map>} files
+ * @return {Promise<String>}
+ */
 function generateMock(Generator, files) {
     var fs = createMockFS(files);
     var book = Book.createForFS(fs);

lib/output/__tests__/json.js

@@ -1,4 +1,4 @@
-var generateMock = require('../generateMock');
+var generateMock = require('./generateMock');
 var JSONGenerator = require('../json');
 
 describe('JSONGenerator', function() {

lib/output/__tests__/website.js

@@ -1,5 +1,5 @@
 var fs = require('fs');
-var generateMock = require('../generateMock');
+var generateMock = require('./generateMock');
 var WebsiteGenerator = require('../website');
 
 describe('WebsiteGenerator', function() {

lib/output/generateBook.js

@@ -13,13 +13,12 @@ var generateAssets = require('./generateAssets');
 var generatePages = require('./generatePages');
 
 /**
-    Process an output to generate the book
-
-    @param {Generator} generator
-    @param {Output} output
-
-    @return {Promise<Output>}
-*/
+ * Process an output to generate the book
+ *
+ * @param {Generator} generator
+ * @param {Output} output
+ * @return {Promise<Output>}
+ */
 function processOutput(generator, startOutput) {
     return Promise(startOutput)
     .then(preparePlugins)
@@ -133,27 +132,26 @@ function processOutput(generator, startOutput) {
 }
 
 /**
-    Generate a book using a generator.
-
-    The overall process is:
-        1. List and load plugins for this book
-        2. Call hook "config"
-        3. Call hook "init"
-        4. Initialize generator
-        5. List all assets and pages
-        6. Copy all assets to output
-        7. Generate all pages
-        8. Call hook "finish:before"
-        9. Finish generation
-        10. Call hook "finish"
-
-
-    @param {Generator} generator
-    @param {Book} book
-    @param {Object} options
-
-    @return {Promise<Output>}
-*/
+ * Generate a book using a generator.
+ *
+ * The overall process is:
+ *     1. List and load plugins for this book
+ *     2. Call hook "config"
+ *     3. Call hook "init"
+ *     4. Initialize generator
+ *     5. List all assets and pages
+ *     6. Copy all assets to output
+ *     7. Generate all pages
+ *     8. Call hook "finish:before"
+ *     9. Finish generation
+ *     10. Call hook "finish"
+ *
+ *
+ * @param {Generator} generator
+ * @param {Book} book
+ * @param {Object} options
+ * @return {Promise<Output>}
+ */
 function generateBook(generator, book, options) {
     options = generator.Options(options);
     var state = generator.State? generator.State({}) : Immutable.Map();

lib/output/generatePage.js

@@ -10,12 +10,12 @@ var createTemplateEngine = require('./createTemplateEngine');
 var callPageHook = require('./callPageHook');
 
 /**
-    Prepare and generate HTML for a page
-
-    @param {Output} output
-    @param {Page} page
-    @return {Promise<Page>}
-*/
+ * Prepare and generate HTML for a page
+ *
+ * @param {Output} output
+ * @param {Page} page
+ * @return {Promise<Page>}
+ */
 function generatePage(output, page) {
     var book = output.getBook();
     var engine = createTemplateEngine(output);
@@ -27,7 +27,7 @@ function generatePage(output, page) {
             var file = resultPage.getFile();
             var filePath = file.getPath();
             var parser = file.getParser();
-            var context = JSONUtils.encodeBookWithPage(book, resultPage);
+            var context = JSONUtils.encodeOutputWithPage(output, resultPage);
 
             if (!parser) {
                 return Promise.reject(error.FileNotParsableError({

lib/output/json/onPage.js

@@ -7,11 +7,11 @@ var getModifiers = require('../getModifiers');
 var JSON_VERSION = '3';
 
 /**
-    Write a page as a json file
-
-    @param {Output} output
-    @param {Page} page
-*/
+ * Write a page as a json file
+ *
+ * @param {Output} output
+ * @param {Page} page
+ */
 function onPage(output, page) {
     var file = page.getFile();
     var readme = output.getBook().getReadme().getFile();

lib/output/preparePlugins.js

@@ -2,11 +2,11 @@ var Plugins = require('../plugins');
 var Promise = require('../utils/promise');
 
 /**
-    Load and setup plugins
-
-    @param {Output}
-    @return {Promise<Output>}
-*/
+ * Load and setup plugins
+ *
+ * @param {Output}
+ * @return {Promise<Output>}
+ */
 function preparePlugins(output) {
     var book = output.getBook();
 

lib/output/website/__tests__/i18n.js

@@ -0,0 +1,38 @@
+var createMockOutput = require('../../__tests__/createMock');
+var prepareI18n = require('../prepareI18n');
+var createTemplateEngine = require('../createTemplateEngine');
+
+var WebsiteGenerator = require('../');
+
+describe('i18n', function() {
+    it('should correctly use english as default language', function() {
+        return createMockOutput(WebsiteGenerator, {
+            'README.md': 'Hello World'
+        })
+        .then(function(output) {
+            return prepareI18n(output);
+        })
+        .then(function(output) {
+            var engine = createTemplateEngine(output, 'README.md');
+            var t = engine.getFilters().get('t');
+
+            expect(t('SUMMARY_INTRODUCTION')).toEqual('Introduction');
+        });
+    });
+
+    it('should correctly use language from book.json', function() {
+        return createMockOutput(WebsiteGenerator, {
+            'README.md': 'Hello World',
+            'book.json': JSON.stringify({ language: 'fr' })
+        })
+        .then(function(output) {
+            return prepareI18n(output);
+        })
+        .then(function(output) {
+            var engine = createTemplateEngine(output, 'README.md');
+            var t = engine.getFilters().get('t');
+
+            expect(t('GITBOOK_LINK')).toEqual('Publié avec GitBook');
+        });
+    });
+});

lib/output/website/createTemplateEngine.js

@@ -18,19 +18,19 @@ var fileToURL = require('../helper/fileToURL');
 var resolveFileToURL = require('../helper/resolveFileToURL');
 
 /**
-    Directory for a theme with the templates
-*/
+ * Directory for a theme with the templates
+ */
 function templateFolder(dir) {
     return path.join(dir, templatesFolder);
 }
 
 /**
-    Create templating engine to render themes
-
-    @param {Output} output
-    @param {String} currentFile
-    @return {TemplateEngine}
-*/
+ * Create templating engine to render themes
+ *
+ * @param {Output} output
+ * @param {String} currentFile
+ * @return {TemplateEngine}
+ */
 function createTemplateEngine(output, currentFile) {
     var book = output.getBook();
     var state = output.getState();
@@ -47,18 +47,17 @@ function createTemplateEngine(output, currentFile) {
     var loader = new Templating.ThemesLoader(tplSearchPaths);
 
     // Get languages
-    var language = config.get('language');
+    var language = config.getValue('language');
 
     // Create API context
     var context = Api.encodeGlobal(output);
 
 
     /**
-        Check if a file exists
-
-        @param {String} fileName
-        @return {Boolean}
-    */
+     * Check if a file exists
+     * @param {String} fileName
+     * @return {Boolean}
+     */
     function fileExists(fileName) {
         if (!fileName) {
             return false;
@@ -69,11 +68,10 @@ function createTemplateEngine(output, currentFile) {
     }
 
     /**
-        Return an article by its path
-
-        @param {String} filePath
-        @return {Object|undefined}
-    */
+     * Return an article by its path
+     * @param {String} filePath
+     * @return {Object|undefined}
+     */
     function getArticleByPath(filePath) {
         var article = summary.getByPath(filePath);
         if (!article) return undefined;
@@ -82,11 +80,10 @@ function createTemplateEngine(output, currentFile) {
     }
 
     /**
-        Return a page by its path
-
-        @param {String} filePath
-        @return {Object|undefined}
-    */
+     * Return a page by its path
+     * @param {String} filePath
+     * @return {Object|undefined}
+     */
     function getPageByPath(filePath) {
         var page = output.getPage(filePath);
         if (!page) return undefined;
@@ -94,7 +91,6 @@ function createTemplateEngine(output, currentFile) {
         return JSONUtils.encodePage(page, summary);
     }
 
-
     return TemplateEngine.create({
         loader: loader,
 
@@ -108,17 +104,17 @@ function createTemplateEngine(output, currentFile) {
 
         filters: defaultFilters.merge({
             /**
-                Translate a sentence
-            */
+             * Translate a sentence
+             */
             t: function t(s) {
                 return i18n.t(language, s);
             },
 
             /**
-                Resolve an absolute file path into a
-                relative path.
-                it also resolve pages
-            */
+             * Resolve an absolute file path into a
+             * relative path.
+             * it also resolve pages
+             */
             resolveFile: function(filePath) {
                 filePath = resolveFileToURL(output, filePath);
                 return LocationUtils.relativeForFile(currentFile, filePath);

lib/output/website/onPage.js

@@ -12,11 +12,11 @@ var createTemplateEngine = require('./createTemplateEngine');
 var fileToOutput = require('../helper/fileToOutput');
 
 /**
-    Write a page as a json file
-
-    @param {Output} output
-    @param {Page} page
-*/
+ * Write a page as a json file
+ *
+ * @param {Output} output
+ * @param {Page} page
+ */
 function onPage(output, page) {
     var options   = output.getOptions();
     var prefix    = options.get('prefix');
@@ -40,7 +40,7 @@ function onPage(output, page) {
     return Modifiers.modifyHTML(page, getModifiers(output, page))
     .then(function(resultPage) {
         // Generate the context
-        var context = JSONUtils.encodeBookWithPage(output.getBook(), resultPage);
+        var context = JSONUtils.encodeOutputWithPage(output, resultPage);
         context.plugins = {
             resources: Plugins.listResources(plugins, resources).toJS()
         };

lib/output/website/prepareI18n.js

@@ -5,11 +5,11 @@ var Promise = require('../../utils/promise');
 var listSearchPaths = require('./listSearchPaths');
 
 /**
-    Prepare i18n, load translations from plugins and book
-
-    @param {Output}
-    @return {Promise<Output>}
-*/
+ * Prepare i18n, load translations from plugins and book
+ *
+ * @param {Output}
+ * @return {Promise<Output>}
+ */
 function prepareI18n(output) {
     var state = output.getState();
     var i18n = state.getI18n();

lib/utils/reducedObject.js

@@ -4,8 +4,13 @@ var Immutable = require('immutable');
  *  Reduce the difference between a map and its default version
  *  @param {Map} defaultVersion
  *  @param {Map} currentVersion
+ *  @return {Map} The properties of currentVersion that differs from defaultVersion
  */
 function reducedObject(defaultVersion, currentVersion) {
+    if(defaultVersion === undefined) {
+        return currentVersion;
+    }
+
     return currentVersion.reduce(function(result, value, key) {
         var defaultValue = defaultVersion.get(key);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitbook",
-  "version": "3.2.0-pre.0",
+  "version": "3.2.1",
   "homepage": "https://www.gitbook.com",
   "description": "Library and cmd utility to generate GitBooks",
   "main": "lib/index.js",
@@ -22,14 +22,14 @@
     "fresh-require": "1.0.3",
     "front-matter": "^2.1.0",
     "gitbook-asciidoc": "1.2.2",
-    "gitbook-markdown": "2.0.0",
+    "gitbook-markdown": "2.0.1",
     "gitbook-plugin-fontsettings": "2.0.0",
     "gitbook-plugin-highlight": "2.0.2",
     "gitbook-plugin-livereload": "0.0.1",
-    "gitbook-plugin-lunr": "1.1.0",
+    "gitbook-plugin-lunr": "1.2.0",
     "gitbook-plugin-search": "2.2.1",
     "gitbook-plugin-sharing": "1.0.2",
-    "gitbook-plugin-theme-default": "1.0.4",
+    "gitbook-plugin-theme-default": "1.0.6",
     "github-slugid": "1.0.1",
     "graceful-fs": "4.1.4",
     "i18n-t": "1.0.1",
@@ -44,7 +44,7 @@
     "moment": "2.13.0",
     "npm": "3.9.2",
     "npmi": "2.0.1",
-    "nunjucks": "2.4.2",
+    "nunjucks": "2.5.2",
     "nunjucks-do": "1.0.0",
     "object-path": "^0.9.2",
     "omit-keys": "^0.1.0",