Bump version to 2.2.0

Allowing for custom chapter-mark and page-break in PDF.

AUTHORS.md

@@ -50,3 +50,5 @@ Translators
 	- Iancu Aurel (@awrelll)
 - Korean
 	- Iancu Aurel (@awrelll)
+- Vietnamese
+    - Hong Nguyen (@nghong)

CHANGES.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.2.0
+- Fix direction in code blocks (always LTR)
+- Add options `chapterMark` and `pageBreaksBefore` for PDF
+- Update code highlighting library
+- `book.json` accessible as `config` in templating syntax
+- Add Vietnamese translation (`vi`)
+
+## 2.1.0
+- Fix error in calcul of `levels` in table of contents, error introduced a few versions ago
+- Add optional `styles/print.css` to replace `print.css` used in ebook
+
 ## 2.0.4
 - Fix `{% raw %}`, got confused with "fake" variable declarations
 - Fix title of language chooser

lib/configuration.js

@@ -186,6 +186,7 @@ Configuration.DEFAULT = {
     // CSS Styles
     "styles": {
         "website": "styles/website.css",
+        "print": "styles/print.css",
         "ebook": "styles/ebook.css",
         "pdf": "styles/pdf.css",
         "mobi": "styles/mobi.css",
@@ -245,6 +246,14 @@ Configuration.DEFAULT = {
         // Choices are [u’a0’, u’a1’, u’a2’, u’a3’, u’a4’, u’a5’, u’a6’, u’b0’, u’b1’, u’b2’, u’b3’, u’b4’, u’b5’, u’b6’, u’legal’, u’letter’]
         "paperSize": "a4",
 
+        // How to mark detected chapters.
+        // Choices are “pagebreak”, “rule”, "both" or “none”.
+        "chapterMark" : "pagebreak",
+
+        // An XPath expression. Page breaks are inserted before the specified elements.
+        // To disable use the expression: "/"
+        "pageBreaksBefore": "/",
+
         // Margin (in pts)
         // Note: 72 pts equals 1 inch
         "margin": {

lib/generators/ebook.js

@@ -18,7 +18,7 @@ var Generator = function(book, format) {
     this.namespace = "ebook";
 
     // Styles to use
-    this.styles = _.compact(["ebook", this.ebookFormat]);
+    this.styles = _.compact(["print", "ebook", this.ebookFormat]);
 
     // Convert images (svg -> png)
     this.convertImages = true;
@@ -68,8 +68,6 @@ Generator.prototype.finish = function() {
             "--book-producer": "GitBook",
             "--publisher": "GitBook",
             "--chapter": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter ')]",
-            "--chapter-mark": "pagebreak",
-            "--page-breaks-before": "/",
             "--level1-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-1 ')]",
             "--level2-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-2 ')]",
             "--level3-toc": "descendant-or-self::*[contains(concat(' ', normalize-space(@class), ' '), ' book-chapter-3 ')]",
@@ -82,6 +80,8 @@ Generator.prototype.finish = function() {
             var pdfOptions = that.options.pdf;
 
             _.extend(_options, {
+                "--chapter-mark": String(pdfOptions.chapterMark),
+                "--page-breaks-before": String(pdfOptions.pageBreaksBefore),
                 "--margin-left": String(pdfOptions.margin.left),
                 "--margin-right": String(pdfOptions.margin.right),
                 "--margin-top": String(pdfOptions.margin.top),

lib/generators/website.js

@@ -50,12 +50,13 @@ Generator.prototype.prepareStyles = function() {
     this.styles = _.chain(this.styles)
         .map(function(style) {
             var stylePath = that.options.styles[style];
-            if (fs.existsSync(path.resolve(that.book.root, stylePath))) {
-                return stylePath;
+            if (stylePath && fs.existsSync(path.resolve(that.book.root, stylePath))) {
+                return [style, stylePath];
             }
             return null;
         })
         .compact()
+        .object()
         .value();
 
     return Q();

lib/template.js

@@ -250,7 +250,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
 
             // Extract main body and kwargs
             var body = args.pop();
-            var kwargs = args.pop() || {};
+            var kwargs = _.isObject(_.last(args))? args.pop() : {};
 
             // Extract blocks body
             var _blocks =  _.map(block.blocks, function(blockName, i){
@@ -316,6 +316,9 @@ TemplateEngine.prototype.renderString = function(content, context, options) {
         // Variables from book.json
         book: this.book.options.variables,
 
+        // Complete book.json
+        config: this.book.options,
+
         // infos about gitbook
         gitbook: {
             version: pkg.version,

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "2.0.4",
+    "version": "2.2.0",
     "homepage": "https://www.gitbook.com",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",
@@ -12,7 +12,7 @@
         "resolve": "0.6.3",
         "fs-extra": "0.16.5",
         "fstream-ignore": "1.0.2",
-        "gitbook-parsers": "0.7.5",
+        "gitbook-parsers": "0.7.6",
         "nunjucks": "mozilla/nunjucks#103513c294835bcbe64222de6db494e2555e294e",
         "nunjucks-autoescape": "1.0.0",
         "nunjucks-filter": "1.0.0",
@@ -32,7 +32,7 @@
         "npm": "2.4.1",
         "dom-serializer": "0.1.0",
         "spawn-cmd": "0.0.2",
-        "highlight.js": "8.4.0",
+        "highlight.js": "8.6.0",
         "escape-string-regexp": "1.0.3"
     },
     "devDependencies": {

test/assertions.js

@@ -35,7 +35,7 @@ should.Assertion.add('html', function(rules, description) {
         var $el = $(query);
 
         // Test number of elements
-        $el.should.have.lengthOf(validations.count);
+        $el.length.should.be.equal(validations.count);
 
         // Test text
         if (validations.text !== undefined) {

test/books/style-print/README.md

@@ -0,0 +1,3 @@
+# Readme
+
+Default description for the book.

test/books/style-print/SUMMARY.md

@@ -0,0 +1 @@
+# Summary

test/books/style-print/styles/print.css

@@ -0,0 +1,3 @@
+body {
+    color: red;
+}

test/ebook.js

@@ -21,4 +21,35 @@ describe('eBook generator', function () {
             book.should.have.file("gitbook/style.css");
         });
     });
+
+    describe('Custom styles', function() {
+        var book;
+
+        before(function() {
+            return books.generate("style-print", "ebook")
+                .then(function(_book) {
+                    book = _book;
+                });
+        });
+
+        it('should remove default print.css', function() {
+            var PAGE = fs.readFileSync(
+                path.join(book.options.output, "index.html"),
+                { encoding: "utf-8" }
+            );
+            PAGE.should.be.html({
+                "link": {
+                    count: 1,
+                    attributes: {
+                        href: "./styles/print.css"
+                    }
+                }
+            });
+        });
+
+        it('should correctly print.css', function() {
+            book.should.have.file("styles");
+            book.should.have.file("styles/print.css");
+        });
+    })
 });

test/plugins.js

@@ -185,6 +185,20 @@ describe('Plugins', function () {
                     content.should.equal("hello;the;world");
                 });
         });
+
+        it('should correctly extend template blocks with arguments', function() {
+            return testTpl('{% test5args "a", "b", "c" %}{% endtest5args %}')
+                .then(function(content) {
+                    content.should.equal("test5a,b,ctest5");
+                });
+        });
+
+        it('should correctly extend template blocks with args and kwargs', function() {
+            return testTpl('{% test5kwargs "a", "b", "c", d="test", e="test2" %}{% endtest5kwargs %}')
+                .then(function(content) {
+                    content.should.equal("test5a,b,c,d:test,e:test2,__keywords:truetest5");
+                });
+        });
     });
 });
 

test/plugins/blocks/index.js

@@ -36,6 +36,21 @@ module.exports = {
                 assert(blk.blocks[1].name, "finally");
                 return [blk.body, blk.blocks[0].body, blk.blocks[1].body].join(blk.kwargs.separator);
             }
-        }
+        },
+        "test5args": {
+            process: function(blk) {
+                return "test5"+blk.args.join(',')+"test5";
+            }
+        },
+        "test5kwargs": {
+            process: function(blk) {
+                var s = blk.args.join(',');
+                for (var key in blk.kwargs) {
+                    s = s + ','+key+':'+blk.kwargs[key];
+                }
+
+                return "test5"+s+"test5";
+            }
+        },
     }
 };

theme/i18n/vi.json

@@ -0,0 +1,20 @@
+{
+    "LANGS_CHOOSE": "Lựa chọn ngôn ngữ",
+    "GLOSSARY": "Chú giải",
+    "GLOSSARY_INDEX": "Chỉ mục",
+    "GLOSSARY_OPEN": "Chú giải",
+    "GITBOOK_LINK": "Xuất bản với GitBook",
+    "SUMMARY": "Mục Lục",
+    "SUMMARY_INTRODUCTION": "Giới thiệu",
+    "SUMMARY_TOGGLE": "Mục Lục",
+    "SEARCH_TOGGLE": "Tìm kiếm",
+    "SEARCH_PLACEHOLDER": "Nhập thông tin cần tìm",
+    "FONTSETTINGS_TOGGLE": "Tùy chỉnh phông chữ",
+    "SHARE_TOGGLE": "Chia sẻ",
+    "SHARE_ON": "Chia sẻ trên {{platform}}",
+    "FONTSETTINGS_WHITE": "Sáng",
+    "FONTSETTINGS_SEPIA": "Vàng nâu",
+    "FONTSETTINGS_NIGHT": "Tối",
+    "FONTSETTINGS_SANS": "Sans",
+    "FONTSETTINGS_SERIF": "Serif"
+}

theme/stylesheets/base/markdown.less

@@ -51,6 +51,7 @@
     pre {
         font-family: monospace, monospace;
         font-size: 1em;
+        direction: ltr;
     }
 
     table {

theme/templates/ebook/layout.html

@@ -11,11 +11,11 @@
         {% if options.author %}<meta name="author" content="{{ options.author }}">{% endif %}
         {% if options.isbn %}<meta name="identifier" content="{{ options.isbn }}" scheme="ISBN">{% endif %}
         {% block head %}{% endblock %}
+        {% block style %}{% endblock %}
         {{ htmlSnippet("head:end")|default("", true)|safe }}
     </head>
     <body>
         {{ htmlSnippet("body:start")|default("", true)|safe }}
-        {% block style %}{% endblock %}
         {% block content %}{% endblock %}
         {% block javascript %}{% endblock %}
         {{ htmlSnippet("body:end")|default("", true)|safe }}

theme/templates/ebook/page.html

@@ -3,7 +3,9 @@
 {% block title %}{{ progress.current.title }} | {{ title }}{% endblock %}
 
 {% block style %}
+    {% if not styles.print %}
     <link rel="stylesheet" href="{{ staticBase }}/print.css">
+    {% endif %}
     {% for resource in plugins.resources.css %}
         {% if resource.url %}
         <link rel="stylesheet" href="{{ resource.url }}">
@@ -11,7 +13,7 @@
         <link rel="stylesheet" href="{{ staticBase }}/plugins/{{ resource.path }}">
         {% endif %}
     {% endfor %}
-    {% for style in styles %}
+    {% for type, style in styles %}
         <link rel="stylesheet" href="{{ basePath }}/{{ style }}">
     {% endfor %}
 {% endblock %}

theme/templates/website/includes/summary.html

@@ -4,21 +4,15 @@
             {% if item.path and item.exists %}
                 {% if not item.external %}
                     <a href="{{ basePath }}/{{ item.path|contentLink }}">
-                        <i class="fa fa-check"></i>
-                        {% if item.level != "0" %}
-                            <b>{{ item.level }}.</b>
-                        {% endif %}
-                        {{ item.title }}
-                    </a>
                 {% else %}
                     <a target="_blank" href="{{ item.path }}">
+                {% endif %}
                         <i class="fa fa-check"></i>
                         {% if item.level != "0" %}
                             <b>{{ item.level }}.</b>
                         {% endif %}
                         {{ item.title }}
                     </a>
-                {% endif %}
             {% else %}
             <span><b>{{ item.level }}.</b> {{ item.title }}</span>
             {% endif %}

theme/templates/website/page.html

@@ -70,7 +70,7 @@ require(["gitbook"], function(gitbook) {
         <link rel="stylesheet" href="{{ staticBase }}/plugins/{{ resource.path }}">
         {% endif %}
     {% endfor %}
-    {% for style in styles %}
+    {% for type, style in styles %}
         <link rel="stylesheet" href="{{ basePath }}/{{ style }}">
     {% endfor %}
 {% endblock %}