Bump version to 0.4.7

More than two section level in summary

README.md

@@ -3,7 +3,7 @@ GitBook
 
 [![Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
 
-GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. A complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
+GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. You can see an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). An [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
 
 ![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
 
@@ -35,23 +35,23 @@ Options for commands `build` and `serve` are:
 --config <config file>    Configuration file to use, defaults to book.json
 ```
 
-GitBook load the default configuration from a `book.json` file in the repository if it exists.
+GitBook loads the default configuration from a `book.json` file in the repository if it exists.
 
 Here are the options that can be stored in this file:
 
 ```
 {
-    // Folders to use for output (caution: it override the value from the command line)
+    // Folders to use for output (caution: it overrides the value from the command line)
     "output": null,
 
-    // Generator to use for building (caution: it override the value from the command line)
+    // Generator to use for building (caution: it overrides the value from the command line)
     "generator": "site",
 
     // Book title and description (defaults are extracted from the README)
     "title": null,
     "description": null,
 
-    // GitHub informations (defaults are extracted using git)
+    // GitHub information (defaults are extracted using git)
     "github": null,
     "githubHost": "https://github.com/",
 
@@ -67,9 +67,9 @@ Here are the options that can be stored in this file:
         }
     },
 
-    // set another theme with your own layout
-    // it's recommended to use plugins or add more options for default theme, though
-    // see https://github.com/GitbookIO/gitbook/issues/209
+    // Set another theme with your own layout
+    // It's recommended to use plugins or add more options for default theme, though
+    // See https://github.com/GitbookIO/gitbook/issues/209
     "theme": "./localtheme",
 
     // Links in template (null: default, false: remove, string: new value)
@@ -98,11 +98,11 @@ You can publish your books to our index by visiting [GitBook.io](http://www.gitb
 
 GitBook can generate your book in the following formats:
 
-* **Static Website**: This is the default format, it generates a complete interactive static website that can be for example hosted on GitHub Pages.
-* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate to this format using: ```gitbook pdf ./myrepo```, you need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
-* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate to this format using: ```gitbook ebook ./myrepo```, you need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.
-* **Single Page**: The book will be stored in a single printable HTML page, this format is used for conversion to PDF or eBook. Generate to this format using: ```gitbook build ./myrepo -f page```.
-* **JSON**: This format is used for debugging or extracting metadata from a book. Generate to this format using: ```gitbook build ./myrepo -f json```.
+* **Static Website**: This is the default format. It generates a complete interactive static website that can be, for example, hosted on GitHub Pages.
+* **PDF**: A complete PDF book with exercise solutions at the end of the book. Generate this format using: ```gitbook pdf ./myrepo```. You need to have [gitbook-pdf](https://github.com/GitbookIO/gitbook-pdf) installed.
+* **eBook**: A complete eBook with exercise solutions at the end of the book. Generate this format using: ```gitbook ebook ./myrepo```. You need to have [ebook-convert](http://manual.calibre-ebook.com/cli/ebook-convert.html) installed.
+* **Single Page**: The book will be stored in a single printable HTML page. This format is used for conversion to PDF or eBook. Generate this format using: ```gitbook build ./myrepo -f page```.
+* **JSON**: This format is used for debugging or extracting metadata from a book. Generate this format using: ```gitbook build ./myrepo -f json```.
 
 ## Book Format
 
@@ -134,7 +134,7 @@ Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
 
 #### Exercises
 
-A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, which is given a code editor to write a solution which is checked against the book author's validation code.
+A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, who is given a code editor to write a solution which is checked against the book author's validation code.
 
 An exercise is defined by 4 simple parts:
 
@@ -143,7 +143,7 @@ An exercise is defined by 4 simple parts:
 * **Solution** code, being a correct solution to the exercise
 * **Validation** code that tests the correctness of the user's input
 
-Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries etc ... that shouldn't be displayed to the user).
+Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries, etc which shouldn't be displayed to the user).
 
     ---
 
@@ -185,7 +185,7 @@ You can see a complete example with the [Learn Git](https://github.com/GitbookIO
 
 #### Ignoring files & folders
 
-GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files, follows the same convention as `.gitignore`)
+GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip. (The format inside those files follows the same convention as `.gitignore`)
 
 #### Cover
 
@@ -196,11 +196,11 @@ A small version of the cover can also be set by creating a file: **/cover_small.
 
 #### Publish your book
 
-The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books", you can create a book on it (public, paid, or private) and update it using **git push**.
+The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books": you can create a book on it (public, paid, or private) and update it using **git push**.
 
 #### Plugins
 
-Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for gitbook.
+Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
 
 ##### Default plugins:
 

bin/gitbook.js

@@ -92,7 +92,7 @@ build.command(prog.command('pdf [source_dir]'))
 
 build.command(prog.command('ebook [source_dir]'))
 .description('Build a gitbook as a eBook')
-.option('-c, --cover <path>', 'Cover image, default is cover.png if exists')
+.option('-c, --cover <path>', 'Cover image, default is cover.jpg if exists')
 .action(function(dir, options) {
     var ext = options.output ? path.extname(options.output) : "epub";
 

lib/generate/ebook/index.js

@@ -19,10 +19,6 @@ var Generator = function() {
     this.options = _.defaults(this.options, {
         extension: "epub"
     });
-
-    if (!this.options.cover && fs.existsSync(path.join(this.options.input, "cover.png"))) {
-        this.options.cover = path.join(this.options.input, "cover.png")
-    }
 };
 util.inherits(Generator, BaseGenerator);
 
@@ -33,6 +29,10 @@ Generator.prototype.finish = function() {
     .then(function() {
         var d = Q.defer();
 
+        if (!that.options.cover && fs.existsSync(path.join(that.options.output, "cover.jpg"))) {
+            that.options.cover = path.join(that.options.output, "cover.jpg");
+        }
+
         var _options = {
             "--cover": that.options.cover
         };

lib/generate/index.js

@@ -238,7 +238,7 @@ var generateBook = function(options) {
         return loadGenerator(options);
     })
 
-    // Detect multi-languages book
+    // Convert files
     .then(function(generator) {
         // Generate the book
         return Q()

lib/generate/site/index.js

@@ -240,8 +240,8 @@ Generator.prototype.writeCacheManifest = function() {
 Generator.prototype.finish = function() {
     var deferred = this.copyAssets().then(this.writeSearchIndex);
 
-    if (this.options.cache) {
-      deferred = deferred.then(this.writeCacheManifest);
+    if (this.options.cache !== false) {
+        deferred = deferred.then(this.writeCacheManifest);
     }
 
     return deferred;

lib/parse/navigation.js

@@ -8,7 +8,7 @@ function clean(obj) {
 
 function flattenChapters(chapters) {
     return _.reduce(chapters, function(accu, chapter) {
-        return accu.concat([clean(chapter)].concat(chapter.articles));
+        return accu.concat([clean(chapter)].concat(flattenChapters(chapter.articles)));
     }, []);
 }
 

lib/parse/summary.js

@@ -86,13 +86,11 @@ function parseTitle(src, nums) {
     };
 }
 
-function parseArticle(chapterNum, nodes, idx) {
-    return parseTitle(_.first(nodes).text, [chapterNum, idx+1]);
-}
-
-function parseChapter(nodes, idx) {
-    return _.extend(parseTitle(_.first(nodes).text, [idx+1]), {
-        articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), parseArticle.bind(null, idx+1))
+function parseChapter(nodes, nums) {
+    return _.extend(parseTitle(_.first(nodes).text, nums), {
+        articles: _.map(listSplit(filterList(nodes), 'list_item_start', 'list_item_end'), function(nodes, i) {
+            return parseChapter(nodes, nums.concat(i + 1));
+        })
     });
 }
 
@@ -104,7 +102,9 @@ function parseSummary(src) {
 
     // Split out chapter sections
     var chapters = _.chain(listSplit(chapterList, 'list_item_start', 'list_item_end'))
-    .map(parseChapter)
+    .map(function(nodes, i) {
+        return parseChapter(nodes, [i + 1]);
+    })
     .value();
 
     return {

package.json

@@ -1,6 +1,6 @@
 {
     "name": "gitbook",
-    "version": "0.4.6",
+    "version": "0.4.7",
     "homepage": "http://www.gitbook.io/",
     "description": "Library and cmd utility to generate GitBooks",
     "main": "lib/index.js",

test/fixtures/SUMMARY.md

@@ -3,6 +3,8 @@
 * [Chapter 1](chapter-1/README.md)
     * [Article 1](chapter-1/ARTICLE1.md)
     * [Article 2](chapter-1/ARTICLE2.md)
+        * [article 1.2.1](chapter-1/ARTICLE-1-2-1.md)
+        * [article 1.2.2](chapter-1/ARTICLE-1-2-2.md)
 * [Chapter 2](chapter-2/README.md)
 * [Chapter 3](chapter-3/README.md)
 * [Chapter 4](chapter-4/README.md)

test/navigation.js

@@ -18,6 +18,8 @@ describe('Summary navigation', function() {
             'chapter-1/ARTICLE1.md',
             'chapter-1/ARTICLE2.md',
             'chapter-2/README.md',
+            'chapter-1/ARTICLE-1-2-1.md',
+            'chapter-1/ARTICLE-1-2-2.md'
         ]);
 
         // Make sure it found the files we gave it
@@ -26,6 +28,8 @@ describe('Summary navigation', function() {
         assert(nav['chapter-1/ARTICLE1.md']);
         assert(nav['chapter-1/ARTICLE2.md']);
         assert(nav['chapter-2/README.md']);
+        assert(nav['chapter-1/ARTICLE-1-2-1.md']);
+        assert(nav['chapter-1/ARTICLE-1-2-2.md']);
 
 
         assert.equal(nav['README.md'].prev, null);
@@ -38,9 +42,15 @@ describe('Summary navigation', function() {
         assert.equal(nav['chapter-1/ARTICLE1.md'].next.path, 'chapter-1/ARTICLE2.md');
 
         assert.equal(nav['chapter-1/ARTICLE2.md'].prev.path, 'chapter-1/ARTICLE1.md');
-        assert.equal(nav['chapter-1/ARTICLE2.md'].next.path, 'chapter-2/README.md');
+        assert.equal(nav['chapter-1/ARTICLE2.md'].next.path, 'chapter-1/ARTICLE-1-2-1.md');
 
-        assert.equal(nav['chapter-2/README.md'].prev.path, 'chapter-1/ARTICLE2.md');
+        assert.equal(nav['chapter-1/ARTICLE-1-2-1.md'].prev.path, 'chapter-1/ARTICLE2.md');
+        assert.equal(nav['chapter-1/ARTICLE-1-2-1.md'].next.path, 'chapter-1/ARTICLE-1-2-2.md');
+
+        assert.equal(nav['chapter-1/ARTICLE-1-2-2.md'].prev.path, 'chapter-1/ARTICLE-1-2-1.md');
+        assert.equal(nav['chapter-1/ARTICLE-1-2-2.md'].next.path, 'chapter-2/README.md');
+
+        assert.equal(nav['chapter-2/README.md'].prev.path, 'chapter-1/ARTICLE-1-2-2.md');
         assert.equal(nav['chapter-2/README.md'].next.path, 'chapter-3/README.md');
     });
 

test/summary.js

@@ -50,5 +50,6 @@ describe('Summary parsing', function () {
 
         assert.equal(c[0].articles[0].level, '1.1');
         assert.equal(c[0].articles[1].level, '1.2');
+        assert.equal(c[0].articles[1].articles[0].level, '1.2.1');
     });
 });

theme/stylesheets/book/summary.less

@@ -90,7 +90,6 @@
                     overflow: hidden;
                     white-space: nowrap;
                     position: relative;
-                    padding-left: 25px;
                 }
 
                 span {

theme/stylesheets/variables.less

@@ -20,7 +20,7 @@
 @sidebar-color:                       hsl(207, 15%, 80%);
 @sidebar-background:                  hsl(207, 15%, 95%);
 
-@sidebar-nested-padding:              10px;
+@sidebar-nested-padding:              20px;
 
 @sidebar-search-padding:              6px;
 @sidebar-search-background:           transparent;

theme/templates/includes/book/summary.html

@@ -1,3 +1,22 @@
+{% macro articles(_articles) %}
+    {% for item in _articles %}
+        <li class="chapter {% if item._path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path %}data-path="{{ item.path|mdLink }}"{% endif %}>
+            {% if item.path %}
+            <a href="{{ basePath }}/{{ item.path|mdLink }}">
+                <i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
+            </a>
+            {% else %}
+            <span><b>{{ item.level }}.</b> {{ item.title }}</span>
+            {% endif %}
+            {% if item.articles.length > 0 %}
+            <ul class="articles">
+                {{ articles(item.articles) }}
+            </ul>
+            {% endif %}
+        </li>
+    {% endfor %}
+{% endmacro %}
+
 <div class="book-summary">
     <div class="book-search">
         <input type="text" placeholder="Search" class="form-control" />
@@ -32,32 +51,7 @@
         <li data-level="0" data-path="index.html">
             <a href="{{ basePath }}/"><i class="fa fa-check"></i> Introduction</a>
         </li>
-        {% for item in summary.chapters %}
-            <li class="chapter {% if item._path == _input %}active{% endif %}" data-level="{{ item.level }}" {% if item.path %}data-path="{{ item.path|mdLink }}"{% endif %}>
-                {% if item.path %}
-                <a href="{{ basePath }}/{{ item.path|mdLink }}">
-                    <i class="fa fa-check"></i> <b>{{ item.level }}.</b> {{ item.title }}
-                </a>
-                {% else %}
-                <span><b>{{ item.level }}.</b> {{ item.title }}</span>
-                {% endif %}
-                {% if item.articles.length > 0 %}
-                <ul class="articles">
-                    {% for article in item.articles %}
-                        <li {% if article._path == _input %}class="active"{% endif %} data-level="{{ article.level }}" {% if article.path %}data-path="{{ article.path|mdLink }}"{% endif %}>
-                            {% if article.path %}
-                            <a href="{{ basePath }}/{{ article.path|mdLink }}">
-                                <i class="fa fa-check"></i> <b>{{ article.level }}.</b> {{ article.title }}
-                            </a>
-                            {% else %}
-                            <span><b>{{ article.level }}.</b> {{ article.title }}</span>
-                            {% endif %}
-                        </li>
-                    {% endfor %}
-                </ul>
-                {% endif %}
-            </li>
-        {% endfor %}
+        {{ articles(summary.chapters) }}
 
         {% if options.links.gitbook !== false %}
         <li class="divider"></li>